ResponseOfCompany
6 properties16 including nested3 operations use this
Properties
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of CompanyResponse required
Array of results for individual records in the operation, may be empty
Model CompanyResponse
id integer (int64) required Unique integer id of the company record
reasons array of Reason
List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted
Model Reason
code string required Integer code of the reason
message string required Message describing the reason for the status of the operation
seq integer (int32) required Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.
status string Status of the operation performed on the record
Values created updated deleted skipped added removed
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Referenced models
Used by
Companies
POSTDelete CompaniesGETGet CompaniesPOSTSync CompaniesGenerated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.