We are pleased to present you our new REST API. At the begining of this documentation we would like to give you some general informations about this API:
It's based on specification. We hope that following the rules of this specification will make our API easy to understand.
This documentation is generated from swagger file - written in
This API always accept application/json format at the API input and always return the same format as output.
API output always follows this scheme:
Following rules applies to the above scheme:
meta
element is always present
meta.numberOfErrors
indicates how many elements errors
array includes
meta.numberOfData
indicates how many elements data
array includes
meta.status
indicates response HTTP status
meta.uniqId
is used to identify request, if your will have some troubles with your request, please make sure that you sent us meta.uniqId
value
meta.someField
may contain additional fields
data
array cannot be present with errors
array if status code is different from HTTP 207 (MULTI-STATUS)
errors
array always consists object with fields: title
, message
and code
.
errors.meta
element may be present inside single error object and contain additional information (that can be parsed) about error
errors.meta.parameter
the parameter that causes the error
errors.meta.value
the value of this parameter passed
errors.meta.source
a link to the entity that caused the error, e.g. externalId
errors.meta.somefield
additional fields that may appear