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/search HTTP/1.1
Host: app.simplicitycollect.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DebtorSearch 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>
<DebtorCompanyName>String</DebtorCompanyName>
<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>
<DebtorFirstName>String</DebtorFirstName>
<DebtorHomePhone>String</DebtorHomePhone>
<DebtorLastName>String</DebtorLastName>
<DebtorMiddleName>String</DebtorMiddleName>
<DebtorSSN>String</DebtorSSN>
<DebtorState>String</DebtorState>
<DebtorZip>String</DebtorZip>
</DebtorSearch>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DebtorSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Debtors">
<Debtors xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors">
<d2p1:Debtor>
<d2p1:EmailConsentTypeID>0</d2p1:EmailConsentTypeID>
<d2p1:EmailTypeID>0</d2p1:EmailTypeID>
<d2p1:accountList xmlns:d4p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors.Accounts">
<d4p1:DebtorAccount>
<d4p1:AccountNumber>String</d4p1:AccountNumber>
<d4p1:AccountStatus>String</d4p1:AccountStatus>
<d4p1:InternalId>0</d4p1:InternalId>
<d4p1:clientName>String</d4p1:clientName>
<d4p1:currentBalanceDue>0</d4p1:currentBalanceDue>
</d4p1:DebtorAccount>
</d2p1:accountList>
<d2p1:addressList xmlns:d4p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors.Addresses">
<d4p1:Address>
<d4p1:ExpressConsentTypeID>0</d4p1:ExpressConsentTypeID>
<d4p1:ExpressConsentTypeName>String</d4p1:ExpressConsentTypeName>
<d4p1:IsDefault>false</d4p1:IsDefault>
<d4p1:address>String</d4p1:address>
<d4p1:addressId>String</d4p1:addressId>
<d4p1:addressTwo>String</d4p1:addressTwo>
<d4p1:city>String</d4p1:city>
<d4p1:country>String</d4p1:country>
<d4p1:county>String</d4p1:county>
<d4p1:fullAddressString>String</d4p1:fullAddressString>
<d4p1:isPrimary>false</d4p1:isPrimary>
<d4p1:skipped_date>0001-01-01T00:00:00</d4p1:skipped_date>
<d4p1:state>String</d4p1:state>
<d4p1:statusId>0</d4p1:statusId>
<d4p1:statusName>String</d4p1:statusName>
<d4p1:statusStyle>String</d4p1:statusStyle>
<d4p1:typeId>0</d4p1:typeId>
<d4p1:typeName>String</d4p1:typeName>
<d4p1:zip>String</d4p1:zip>
</d4p1:Address>
</d2p1:addressList>
<d2p1:aka>String</d2p1:aka>
<d2p1:company_name>String</d2p1:company_name>
<d2p1:contacts xmlns:d4p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors.Contacts">
<d4p1:DebtorContact>
<d4p1:DebtorID>0</d4p1:DebtorID>
<d4p1:ID>0</d4p1:ID>
<d4p1:Name>String</d4p1:Name>
<d4p1:Title>String</d4p1:Title>
</d4p1:DebtorContact>
</d2p1:contacts>
<d2p1:customFieldsList>
<d2p1:DebtorCustomField>
<d2p1:DataType>Decimal</d2p1:DataType>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:FieldValue>String</d2p1:FieldValue>
<d2p1:TableColumnName>String</d2p1:TableColumnName>
</d2p1:DebtorCustomField>
</d2p1:customFieldsList>
<d2p1:dob>0001-01-01T00:00:00</d2p1:dob>
<d2p1:email>String</d2p1:email>
<d2p1:employer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors.Employers">
<d4p1:address>String</d4p1:address>
<d4p1:address_two>String</d4p1:address_two>
<d4p1:cell>String</d4p1:cell>
<d4p1:city>String</d4p1:city>
<d4p1:contact>String</d4p1:contact>
<d4p1:county>String</d4p1:county>
<d4p1:email>String</d4p1:email>
<d4p1:fax>String</d4p1:fax>
<d4p1:full_time>false</d4p1:full_time>
<d4p1:garnish_return_days>String</d4p1:garnish_return_days>
<d4p1:id>0</d4p1:id>
<d4p1:name>String</d4p1:name>
<d4p1:notes>String</d4p1:notes>
<d4p1:phone>String</d4p1:phone>
<d4p1:state>String</d4p1:state>
<d4p1:updated_by_user_id>0</d4p1:updated_by_user_id>
<d4p1:zip>String</d4p1:zip>
</d2p1:employer>
<d2p1:first_name>String</d2p1:first_name>
<d2p1:id>0</d2p1:id>
<d2p1:is_company>false</d2p1:is_company>
<d2p1:last_name>String</d2p1:last_name>
<d2p1:last_updated>0001-01-01T00:00:00</d2p1:last_updated>
<d2p1:middle_name>String</d2p1:middle_name>
<d2p1:paymentIDList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:paymentIDList>
<d2p1:phoneList xmlns:d4p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Debtors.Phones">
<d4p1:Phone>
<d4p1:DebtorID>0</d4p1:DebtorID>
<d4p1:SMSConsentDate>0001-01-01T00:00:00</d4p1:SMSConsentDate>
<d4p1:SMSConsentTypeID>0</d4p1:SMSConsentTypeID>
<d4p1:SMSConsentTypeName>String</d4p1:SMSConsentTypeName>
<d4p1:VoiceConsentDate>0001-01-01T00:00:00</d4p1:VoiceConsentDate>
<d4p1:VoiceConsentTypeID>0</d4p1:VoiceConsentTypeID>
<d4p1:VoiceConsentTypeName>String</d4p1:VoiceConsentTypeName>
<d4p1:clickToDialLink>String</d4p1:clickToDialLink>
<d4p1:descriptionId>0</d4p1:descriptionId>
<d4p1:descriptionName>String</d4p1:descriptionName>
<d4p1:displayPhone>String</d4p1:displayPhone>
<d4p1:extension>String</d4p1:extension>
<d4p1:isPrimary>false</d4p1:isPrimary>
<d4p1:phone>String</d4p1:phone>
<d4p1:phoneId>String</d4p1:phoneId>
<d4p1:phoneNumber>String</d4p1:phoneNumber>
<d4p1:skipped_date>0001-01-01T00:00:00</d4p1:skipped_date>
<d4p1:statusId>0</d4p1:statusId>
<d4p1:statusName>String</d4p1:statusName>
<d4p1:statusStyle>String</d4p1:statusStyle>
<d4p1:timezoneName>String</d4p1:timezoneName>
<d4p1:typeId>0</d4p1:typeId>
<d4p1:typeName>String</d4p1:typeName>
</d4p1:Phone>
</d2p1:phoneList>
<d2p1:prefix>String</d2p1:prefix>
<d2p1:ssn>String</d2p1:ssn>
<d2p1:suffix>String</d2p1:suffix>
<d2p1:type>String</d2p1:type>
</d2p1:Debtor>
</Debtors>
<Message>String</Message>
<Status>String</Status>
</DebtorSearchResponse>