Versions Compared

Old Version 2

changes.mady.by.user Christina Georgiou (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Christina Georgiou (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R15.0.0

Excerpt

This method cancels a Service Request, which is in Pending life cycle state.

...

Name

Type

Description

token

String

The token retrieved from the login method

service_request_identifier

(mandatory)

Service Request Identifier

The identifier of the Service Request to be cancelled. The allowed Service Request identifier fields are the following:

Include Page
V4:feedbackservice_classificationrequest_identifier
V4:feedbackservice_classificationrequest_identifier

status_identifier

(optional)

Service Request Status Identifier

The status that will be set on the Service Request, after the cancellation. If not specified the the default status for cancelling Service Requests of that type will be used. The allowed service request status identifiers are the following:

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

cancellation_reason_identifier

(optional)

Service Request Cancellation Reason Identifier

The reason for cancelling the Service Request. If not specified, then the default cancellation reason of the service request's type will be used. The allowed cancellation reason identifiers are the following:

Include Page
V4:service_request_cancellation_reason_identifier
V4:service_request_cancellation_reason_identifier

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

...

Expand
titleExample 1

HTTP Method: POST 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "token":"{{token}}",
    "service_request_identifier": { "number" : "SR00000584"},
    "status_identifier": { "name": "Cancel"},
    "cancellation_reason_identifier": { "name": "Cancellation Reason C"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "numbernotes": "SR00000584"null,
        "descriptionlog_information": {
   null,         "accountscreated_by_receivableunit": {
                "numberalternative_code": "ACR0000000121adminunit",
                "group_name": "ACR0000000121Main Rosa LediGroup",
                "idcommunity_name": "49BE13F9B0C54F95A6A6D61C3C8A00BBCommunity",
                "life_cycle_statename": "ACTIVEAdmin Unit",
                "account_ownerdescription": { "admin unit",
                "company_profileid": null,"1"
            },
            "companyupdated_by_nameunit": null,{
                "namealternative_code": "Rosa  Lediadminunit",
                "lastgroup_name": "LediMain Group",
                "idcommunity_name": "FA07B68E7F5D4ED0AFC7268CB8F80194Community",
                "life_cycle_statename": "FINANCIALAdmin Unit",
                "middle_namedescription": "admin nullunit",
                "titleid": null,"1"
            },
            "typecreated_date": "PERSON2018-08-22T17:57:55",
   
            "firstupdated_namedate": "Rosa2018-08-23T09:45:01",
   
            "demographicsupdated_by_user": {
   
                "person_name_day": { "CRM COM",
                "id": "1",
        "month": null,       "email": "dev@crm.com",
                "dayusername": "MPAdministrator"
 null           },
         },   "created_by_user": {
                "idperson_numbername": "546932CRM COM",
                    "passport_number_expiration_date"id": null,
   "1",
                "genderemail": "FEMALEdev@crm.com",
                "username": "MPAdministrator"
    "date_of_birth": {       }
        },
        "monthservices_set": null[],
        "urgency_level": "URGENCY2",
        "type": {
            "yearalternative_code": null"reter",
            "name": "test",
            "daydescription": null,
            "id": "E8CE69B3AF524E908F4FE2BD77B0F41A"
        },
           "number": "SR00000584",
        "id_number_expiration_datetemporary_resolution": null,{
               "temporarily_resolved_by": null,
    "industry_sector": null,       "description": null,
            "passportaccepted_numberby": null,
            "temporary_resolution_date": null,
            "industrycategory": null,
           },
        "socialfinal_security_numberresolution": null,{
            "finally_resolved_by": null,
            "idfinal_issuedresolution_by_countrydate": null,
            "description": null,
            "passport_issuedaccepted_by_country": null,
            "category":  null
 }       },
     }      "caller_email": null,
  },      "id": "78EE3891411C458080E55C3042A51EA9",
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": {
            "number": "1",
            "name": "Station",
            "id": "E055FF075E4A4072BD09AF1091AA1CC3",
            "hierarchy_level": 1
        },
        "udf_string_1": null,
        "life_cycle_state": "CANCELLED",
        "cancellation_reason": {
            "alternative_code": "CRC",
            "name": "Cancellation Reason C",
            "description": "A third cancellation reason for testing",
            "id": "4FB30EE8161B4694931E59F1A5B390FA"
        },
        "caller_phone": null,
        "impact_level": "IMPACT1",
        "referring_to": {
            "subscription": null,
            "job": null
        },
        "physical_goods_set": [],
        "time_overdue": {
            "time_period_uot": null,
            "time_period_value": null
        },
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "status": {
            "alternative_code": "Cancel",
            "name": "Cancel",
            "description": null,
            "id": "85B18C6367BF4B9E93091A29FE1B263F",
            "life_cycle_state": "CANCELLED"
        },
        "owned_by_group": {
            "alternative_code": "G",
            "community_name": "CommunityA",
            "name": "GroupA",
            "description": null,
            "id": "3C2CB11804164440857E21996C0286D4"
        },
        "description": null,
        "related_service_requests_set": [],
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "estimated_completion_time": {
            "time_period_uot": "DAYS",
            "time_period_value": 1
        },
        "related_jobs_set": [],
        "related_activities_set": [],
        "udf_float_1": null,
        "udf_float_2": null,
        "start_date": "2018-08-22T17:57:31",
        "assigned_to": {
            "unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "actual_completion_date": null,
        "accounts_receivable": {
            "number": "ACR0000000121",
            "name": "ACR0000000121 Rosa Ledi",
            "id": "49BE13F9B0C54F95A6A6D61C3C8A00BB",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Rosa  Ledi",
                "last_name": "Ledi",
                "id": "FA07B68E7F5D4ED0AFC7268CB8F80194",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Rosa",
                "demographics": {
                    "id_number": "546932",
                    "gender": "FEMALE",
                    "country_of_residence": {
                        "alternative_code": "IRN",
                        "three_character_code": null,
                        "name": "IRAN (ISLAMIC REPUBLIC OF)",
                        "id": "231",
                        "two_character_code": null
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "industry": null,
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "passport_number_expiration_date": null,
                    "id_number_expiration_date": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "priority_level": 2,
        "time_to_completion": {
            "time_period_uot": "HOURS",
            "time_period_value": 8.17
        },
        "caller": {
            "company_profile": null,
            "company_name": null,
            "name": "Rosa  Ledi",
            "last_name": "Ledi",
            "id": "FA07B68E7F5D4ED0AFC7268CB8F80194",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Rosa",
            "demographics": {
                "id_number": "546932",
                "gender": "FEMALE",
                "country_of_residence": {
                    "alternative_code": "IRN",
                    "three_character_code": null,
                    "name": "IRAN (ISLAMIC REPUBLIC OF)",
                    "id": "231",
                    "two_character_code": null
                },
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "industry": null,
                "name_day": {
                    "month": null,
                    "day": null
                },
                "passport_number_expiration_date": null,
                "id_number_expiration_date": null,
                "passport_number": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "response": {
            "responded_by": null,
            "response_date": null,
            "description": null,
            "accepted_by": null,
            "category": null
        },
        "category": {
            "code": "I",
            "parent_id": null,
            "name": "MAJOR TECHNOLOGICAL EQUIPMENT",
            "description": "MAJOR TECHNOLOGICAL EQUIPMENT",
            "id": "56C28BBE17DE411FB22722BBE26A6CE8",
            "classification": "78EE3891411C458080E55C3042A51EA9"REPORT_AN_INCIDENT"
        },
        "lifeexpected_cyclecompletion_statedate": "CANCELLED2018-08-23T17:57:31"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}