(Quick Reference)
75 Reasons - Reference Documentation
Version: 2.1
75 Reasons
75.1 List
Service: List reasons
Description: This web service returns a json list of reasons.
URL:
https://BASE_URL/api/VERSION/reasons
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The
max parameter is set to
100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| name | Wildcard search by the resource's name | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Status: HTTP/1.1 200 OK
{
"paging": {
"total": 5,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"name": "no sale",
"type": "1",
"isActive": true,
"organization": "entity1",
"dateCreated": "2015-12-31T15:45:58Z",
"lastUpdated": "2015-12-31T15:45:58Z"
},
{
"id": 2,
"name": "whse transaction",
"type": "3",
"isActive": true,
"organization": "entity1",
"dateCreated": "2016-01-07T10:22:43Z",
"lastUpdated": "2016-01-07T10:22:43Z"
}…
]
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}75.2 Show
Service: Show a reason
Description: This web service return an existing reason of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/reasons/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired reason | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 2,
"name": "whse transaction",
"type": "3",
"isActive": true,
"organization": "entity1",
"dateCreated": "2016-01-07T10:22:43Z",
"lastUpdated": "2016-01-07T10:22:43Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The reason with the id 10 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}75.3 Create
Service: Create a reason
Description: Returns the created reason in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/reasons
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| name | | String | yes | |
| type | Should be equal to 1 for no sale or 2 for free invoice or 3 for warehouse transaction | Integer | yes | 1,2,3 |
| isActive | By default, it is set to true | Boolean | no | true, false |
Success Output
Status: HTTP/1.1 201 Created
{
"id": 7,
"name": "Closed point of sale",
"type": "1",
"isActive": true,
"organization": "entity1",
"dateCreated": "2016-08-22T11:06:20Z",
"lastUpdated": "2016-08-22T11:06:20Z"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "missing_param",
"error_description": "name parameter is missing"
}75.4 Update
Service: Update a reason
Description: Returns the updated reason in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/reasons/{id}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired reason | Integer | yes | 123 |
| name | | String | yes | |
| type | Should be equal to 1 for no sale or 2 for free invoice or 3 for warehouse transaction | Integer | yes | 1,2,3 |
| isActive | By default, it is set to true | Boolean | no | true, false |
Success Output
Status: HTTP/1.1 200 OK
{
"id": 7,
"name": "Closed point of sale",
"type": "1",
"isActive": false,
"organization": "entity1",
"dateCreated": "2016-08-22T11:06:20Z",
"lastUpdated": "2016-08-22T11:21:08Z"
} Failure Output
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The reason with the id 70 doesn't exist."
} Status: HTTP/1.1 400 Bad Request
{
"error": "save_failed",
"error_description": "Failed to save instance"
}75.5 Delete
Service: Delete a reason
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/reasons/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired reason | Integer | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The reason with the id 70 doesn't exist."
}
