SimplicityCollect Web Services API

<back to all web services

DebtorUpdate

The following routes are available for this service:
All Verbs/debtors/update
DebtorUpdate Parameters:
NameParameterData TypeRequiredDescription
ApiTokenquerystringNo
DebtorIdquerystringNo
DebtorFirstNamequerystringNo
DebtorMiddleNamequerystringNo
DebtorLastNamequerystringNo
DebtorAddressquerystringNo
DebtorCityquerystringNo
DebtorStatequerystringNo
DebtorZipquerystringNo
DebtorDOBquerystringNo
DebtorEmployerNamequerystringNo
DebtorEmployerPhonequerystringNo
DebtorHomePhonequerystringNo
DebtorCellPhonequerystringNo
DebtorEmailquerystringNo
DebtorEmailConsentTypequerystringNo
DebtorCustomFieldsqueryList<DebtorCustomField>No
DebtorCustomField Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
FieldValueformstringNo
TableColumnNameformstringNo
DataTypeformMySqlDbTypeNo
DebtorUpdateResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /debtors/update HTTP/1.1 
Host: app.simplicitycollect.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DebtorUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Debtors">
  <ApiToken>String</ApiToken>
  <DebtorAddress>String</DebtorAddress>
  <DebtorCellPhone>String</DebtorCellPhone>
  <DebtorCity>String</DebtorCity>
  <DebtorCustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors">
    <d2p1:DebtorCustomField>
      <d2p1:DataType>Decimal</d2p1:DataType>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:FieldValue>String</d2p1:FieldValue>
      <d2p1:TableColumnName>String</d2p1:TableColumnName>
    </d2p1:DebtorCustomField>
  </DebtorCustomFields>
  <DebtorDOB>String</DebtorDOB>
  <DebtorEmail>String</DebtorEmail>
  <DebtorEmailConsentType>String</DebtorEmailConsentType>
  <DebtorEmployerName>String</DebtorEmployerName>
  <DebtorEmployerPhone>String</DebtorEmployerPhone>
  <DebtorFirstName>String</DebtorFirstName>
  <DebtorHomePhone>String</DebtorHomePhone>
  <DebtorId>String</DebtorId>
  <DebtorLastName>String</DebtorLastName>
  <DebtorMiddleName>String</DebtorMiddleName>
  <DebtorState>String</DebtorState>
  <DebtorZip>String</DebtorZip>
</DebtorUpdate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtorUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Debtors">
  <Message>String</Message>
  <Status>String</Status>
</DebtorUpdateResponse>