Description: This web service is used to update an authority object
URL:
https://BASE_URL/api/VERSION/authorities/{id}
URL with external_id:
https://BASE_URL/api/VERSION/authorities/reference/{id}
Method: 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..." }