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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiToken: String,
	DebtorId: String,
	DebtorFirstName: String,
	DebtorMiddleName: String,
	DebtorLastName: String,
	DebtorAddress: String,
	DebtorCity: String,
	DebtorState: String,
	DebtorZip: String,
	DebtorDOB: String,
	DebtorEmployerName: String,
	DebtorEmployerPhone: String,
	DebtorHomePhone: String,
	DebtorCellPhone: String,
	DebtorEmail: String,
	DebtorEmailConsentType: String,
	DebtorCustomFields: 
	[
		{
			FieldName: String,
			FieldValue: String,
			TableColumnName: String,
			DataType: Decimal
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: String,
	Message: String
}