GET service_requests/configuration/statuses/list

This method returns the statuses that are allowed to be used by service requests of specific type. Multiple statuses are returned by each call

Available from CRM.COM R9.0.0

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 type of the service request that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed service request type identifier fields 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

life_cycle_state

(optional)

Sting

The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are:

PENDING, RESPONDED, TEMPORARY RESOLVED, FINAL RESOLVED and COMPLETED

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 service request type status
default	Boolean	Determines if the service request type status is the default status or not
status	Service Request Status Object	The actual status provided by the service request type status

Referred Objects Response Data

service_request_status object response data

Name	Type	Description
id	String	The ID of the retrieved service request status
name	String	The name of the retrieved service request status
alternative_code	String	The alternative code of the retrieved service request status
description	String	A description of the retrieved service request status
life_cycle_state	String	The life cycle state related with the retrieved service request status. The supported life cycle states are the following: PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "4174EEED1CBFD73A67AB75C5DF99AFED",
                "name": "To Be Approved",
                "description": "To be Approved - Pending",
                "alternative_code": "TBA"
            },
            "id": "7244393FFDA6E09D16CACCA0A87D8772"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "3719E9998E567A788A865CD1B4556821",
                "name": "Assigned",
                "description": "Assigned",
                "alternative_code": "ASG"
            },
            "id": "6FB8BA4DD6658972FC5AD9D6C74D9A84"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "C46FA997FD069D6F1863F4F6A02916C6",
                "name": "In Progress",
                "description": null,
                "alternative_code": "IP"
            },
            "id": "8A79FE4BBDA349FC61E8875DE034FDEE"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "TEMPORARY_RESOLVED",
                "id": "0B7EF8D78A8711BA03FFF11EB0BBC0F6",
                "name": "Temporary Solution",
                "description": null,
                "alternative_code": "TS"
            },
            "id": "BFF9AB00ADAF3A860FBDDDC0D30BA039"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "FINAL_RESOLVED",
                "id": "78BD681A48EE3EAE9246D25AB76F632B",
                "name": "Final Solution",
                "description": null,
                "alternative_code": "FS"
            },
            "id": "0F0CCA77C5AF23955E2CF9277BE2D733"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "COMPLETED",
                "id": "5611E4C4BD556315E1AE9F9A883158D2",
                "name": "Accepted by Customer",
                "description": "The Service Request has been accepted by customer/caller ",
                "alternative_code": "ACC"
            },
            "id": "FE655F50C6A9BFD9E847291B6E706785"
        }
    ]
}