Skip to main content

CommonResponseContract Schema

Data structure for Common Response Contract objects.

Fields​

FieldTypeRequiredDescriptionNotes
company_idsint32CollectionNo-API field: company_ids
error_codestringNo-API field: error_code
error_info_argumentsstringCollectionNo-API field: error_info_arguments
error_messagestringNo-API field: error_message
response_dataStringRecordNo-API field: response_data
successstringNo--

Example​

{
"company_ids": [
123
],
"error_code": "string",
"error_info_arguments": [
"value"
],
"error_message": "string",
"response_data": {
"id": "object-id"
},
"success": "string"
}