Description
API contract to manage Commercial Card operations
Sorting and Pagination
--------------------
The maximum elements returned per pagination is set to 30.
To limit, or page, and sort the data that is returned, use these, query parameters :
Query parameter details
| Parameter | Type | Description |
|-----------|---------|--------------------------------------------------------|
| size | integer | The number of items to return in the response. |
| page| integer | The page number to display. eg : 1 for the first page of size elements |
| paginate| boolean | Specify if want to return total record matching your query. |
Responses
the system associates an internal unique identifier for referencing that resource.
* All paginate response are composed as below
| Parameter | Type | Description |
|-----------|---------|--------------------------------------------------------|
| size | integer | The number of items to list in the response. |
| page | integer | The sort order index of the first resource in the returned array.|
| totalRecord | integer |if paginate true, return the total number of records match the query |
* Error response
* code : specific error code
* message : short HTTP error message
* description : Long description of error
HTTP Status Code
* Success
We are two type of response: one for query list witch return an array(items) and other witch return on object (item)
The following status codes of HTTP are used :
* 2xx - the request was Successfully accepted and was or will be processed.
* Error
Base on RFC 7807 - Problem Details for HTTP APIs :
* 4xx - the request was rejected due to a problem with the
information sent by the client.
* 5xx - something unexpected occurred while fulfilling the request;
the request may or may not have been processed,
depending on the error. Digital card mobile API version du build 1.0.0