(Quick Reference)
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}
URL with external_id:
https://BASE_URL/api/VERSION/authorities/reference/{id}
Method: 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."
}