GET jobs/configuration/cancellation_reasons/list
- Former user (Deleted)
- p_demou (Deactivated)
As of CRM.COM R13.0.0, the method returns the allowed cancellation reasons based on the job type. Job Definitions become deprecated in CRM.COM R13.0.0
This method returns the cancellation reasons that are allowed to be used by jobs, as defined on the active job definition. Multiple cancellation reasons are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
job_type_identifier (mandatory) | Job Type Identifier | The identifier of the job type for which the cancellation reasons will be retrieved. The allowed job type identifiers are the following:
Available from CRM.COM R13.0.0 | ||||||||||||
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 job cancellation reason |
name | String | The name of the retrieved job cancellation reason |
alternative_code | String | The alternative code of the retrieved job cancellation reason |
| description | String | A description of the retrieved job cancellation reason |
| default | Boolean | Indicates the default cancellation reason if the specified job type Available from CRM.COM R13.0.0 |
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"default": true,
"alternative_code": "R",
"name": "Regret",
"description": null,
"id": "1204F1C8DDEA430B8C1E375B60A9BB21"
},
{
"default": false,
"alternative_code": "WII",
"name": "Wrong Input/Missing Information",
"description": null,
"id": "716632CA6EF8482B818B78F4018800E2"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}