This method returns the cancellation reasons that are allowed to be used by activities, as defined on the active activity definition. Multiple cancellation reasons are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved activity cancellation reason |
name | String | The name of the retrieved activity cancellation reason |
alternative_code | String | The alternative code of the retrieved activity cancellation reason |
| description | String | A description of the retrieved activity cancellation reason |
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"id": "352B746264664A96BC9FC2C16816B7F5",
"name": "Cancel Reason 1",
"description": "Description",
"alternative_code": "CR1"
},
{
"id": "8CE6FE0AD2CC42C0B5D8A7AF660FCEC5",
"name": "Cancel Reason 2",
"alternative_code": "CR2"
},
{
"id": "D38A9C9649AF4EF2BF8F5BA25DCE4AF7",
"name": "Cancel Reason 3",
"alternative_code": "CR3"
}
]
}