(Quick Reference)
5 Authorities - Reference Documentation
Version: 2.1
5 Authorities
5.1 List
Service: List of authorities
Description: This web service returns a json list of authorities.
URL:
https://BASE_URL/api/VERSION/authorities
: 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 authority'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": 2,
"max": 10,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 22,
"name": "CEO",
"dateCreated": "2017-01-17T10:30:12Z",
"lastUpdated": "2017-01-17T12:28:32Z"
},{
"id": 45,
"name": "Delivery Man",
"dateCreated": "2017-01-20T14:10:13Z",
"lastUpdated": "2017-01-20T15:15:24Z"
}
]
} 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."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016/08/29]"
} Status: HTTP/1.1 500 Internal Server Error
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}5.2 Show
Service: Show an authority
Description: This web service return an existing authority object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/authorities/{id}:
https://BASE_URL/api/VERSION/authorities/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted record | Long/String | Yes | 777 |
The name of authority can be used as an external ID
Success Output
Success case: response.status = 200
{
"id": 11,
"name": "CEO",
"dateCreated": "2016-09-09T08:18:51Z",
"lastUpdated": "2016-09-09T08:18:51Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The authority with the id 999 doesn't exist."
}5.3 Create
Service: Save an authority
Description: This web service is used to add a new authority object to the database
URL:
https://BASE_URL/api/VERSION/authorities
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| name | the name of the new authority | String | Yes | |
Success Output
Success case: response.status=201
{
"id": 11,
"name": "CEO",
"dateCreated": "2016-09-09T08:18:51Z",
"lastUpdated": "2016-09-09T08:18:51Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "already_existing",
"error_description": "Authority is already existing."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}5.4 Update
Service: Update an authority
Description: This web service is used to update an authority object
URL:
https://BASE_URL/api/VERSION/authorities/{id}:
https://BASE_URL/api/VERSION/authorities/reference/{id}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long/String | yes | 777 |
| name | | String | yes | |
The name of authority can be used as an external ID
Success Output
Success case: response.status = 20
{
"id": 11,
"name": "CEO",
"dateCreated": "2016-09-09T08:18:51Z",
"lastUpdated": "2016-09-09T08:18:51Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error": "not_found",
"error_description": "The authority with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}5.5 Delete
Service: Delete an authority
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/authorities/{id}:
https://BASE_URL/api/VERSION/authorities/reference/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired authority | Long/String | yes | 123 |
The name of authority can be used as an external ID
Success Output
Success case: response.status = 200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The authority with the id 706 doesn't exist."
}
