Responses

DataTable calls return the following responses:

List fields

The call returns the fields for the requested data table. For an example, see ListFields.

Read calls

If successful, the response returns the fields for the specified record. If the record is not found, the response does not return any results.

Sample "record not found" response
<ResponseSummary>
<CurrentPage type="Numeric">1</CurrentPage>
<ItemsPerPage type="Numeric">30</ItemsPerPage>
<TotalItemCount type="Numeric">0</TotalItemCount>
</ResponseSummary>
<FieldNames/>
<Response type="List"/>
</Result>

Update calls

Success
<Response>
<RecordsAffected type="List">
<Result>
<RecordID>[Record ID]</RecordID>
<Code>SUCCESS</Code>
</Result>
</RecordsAffected>
Record not found
<Response>
<RecordsAffected type="List"/>
<Code>RECORD_NOT_FOUND</Code>
<Message>Found no record with the given criteria</Message>
</Response>
Update failed
<Response><RecordsAffected type="List"><Result>
<RecordID>[Record ID]</RecordID>
<Code>UPDATE_FAILED</Code>
<Message>Update failed for the given records</Message>
<ErrorList>
<Contact.CoreField.Email1>Email address is not valid</Contact.CoreField.Email1>
</ErrorList>

Create calls

Success
<Response>
<RecordsAffected type="List">
<Result>
<RecordID>[Record ID]</RecordID>
<Code>SUCCESS</Code>
</Result>
</RecordsAffected>
Failure
<Response>
<Code>CREATION_FAILED</Code>
<Message>Creation failed for the given record</Message>
<ErrorList>
<Contact.CoreField.Last_Name>This field must be filled</Contact.CoreField.Last_Name>
</ErrorList>
</Response>

Delete calls

Success
<Response>
<RecordsAffected type="List">
<Result>
<RecordID>[Record ID]</RecordID>
<Code>SUCCESS</Code>
</Result>
</RecordsAffected>
</Response>
</Result>
Record not found
<Response>
<RecordsAffected type="List"/>
<Message>Found no record with the given criteria</Message>
<ErrorList>
<ErrorDetails>Found no record with the given criteria</ErrorDetails>
</ErrorList>
</Response>
</Result>