Skip to end of banner
Go to start of banner

GET service_requests/configuration/cancellation_reasons/list

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Availabe from CRM.COM R15.0.0

This method returns the cancellation reasons that are allowed to be used by service requests, as defined on the service request type. Multiple cancellation reasons are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

service_request_type_identifier

(mandatory)

Service Request Type Identifier

The identifier of the job type for which the cancellation reasons will be retrieved. The allowed job type identifiers are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request type

name

(semi-optional)

String

The name of the service request type

alternative_code

(semi-optional)

String

The alternative code of  the service request type

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 retrievedcancellation reason

name

String

The name of the retrievedcancellation reason

alternative_code

String

The alternative code of the retrievedcancellation reason

descriptionStringA description of the retrievedcancellation reason
defaultBoolean

Indicates the default cancellation reason if the specified type

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 

 
  • No labels