Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Excerpt

This method updates service requests. A single service request can be updated by each call and only if it is not completed. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

service_request_identifier

(optional)

Service Request Identifier

The service request that should be updated. The allowed service request identifier fields are the following:

Include Page
v4:service_request_identifier
v4:service_request_identifier

caller_email

(optional)

StingThe email of the caller.

caller_phone

(optional)

Sting

The phone of the caller.

Tip

Available from CRM.COM R10.0.0


description

(optional)

StringA description of the service request

notes

(optional)

String
Shared
The shared notes
fir
of the service request

status_identifier

(mandatory on conditions)

Service Request Status Identifier

The status of the service request is mandatory to be specified if temporary_resoution or final_resolution identifiers are updated. The allowed service request status identifier fields are the following:

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

category_identifier

(optional)

Service Request Category Identifier

The category of the service request. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_identifier

urgency_level

(optional)

String

The urgency level of the service request, which can be one of the following:

URGENCY1, URGENCY2, URGENCY3, CUSTOM1,

CUSTOM2 ,

CUSTOM2

Tip

For releases prior CRM.COM R14.0.0, the following urgency levels CUSTOM3, CUSTOM4

,

and CUSTOM5 are supported as well


impact_level

(optional)

String

The impact level of the service request, which can be one of the following:

IMPACT1, IMPACT2, IMPACT3, CUSTOM1,

CUSTOM2 ,

CUSTOM2

Tip

For releases prior CRM.COM R14.0.0, the following impact levels CUSTOM3, CUSTOM4

,

and CUSTOM5 are supported as well


owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the service request. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the service request. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

Tip

Deprecated from CRM.COM R18.0.0


udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_2 

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

start_date
(optional)

DateThe date that the activity is created

expected_completion_date
(optional)

DateThe date that the service request is expected to be completed. It is automatically calculated if estimate completion time is specified.
 estimated_completion_time
(optional)
Time Period ObjectThe time that is estimated to complete the service request, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.
assigned_to
(optional)
Assigned to objectThe assignment information for the service request

referring_to

(optional)

Service Request Referring To ObjectThe entities that the service request is referring to which can be a subscription or a job

response

(optional)
Service Request Response ObjectThe response that will be provided to the service request

temporary_resolution

(optional)

Service Request Temporary Resolution Object

The temporary resolution that will be provided to the service request

final_resolution

(optional)

Service Request Final Resolution ObjectThe final resolution that will be provided to the service request

services_set

(optional)

Set of Service Request Services Objects

A list of services for which the service request was raised for

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

physical_goods_set

(optional)

Set of Service Request Physical Goods Objects

A list of the physical goods for which the service request was raised for, which can be traceable or not traceable

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

related_service_requests_set

(optional)

Set of Related Service Request Objects

A list with the service requests that the raised service request relates to

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

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

Anchor
service_request_create referred objects parameters
service_request_create referred objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
	"token" : "482AF0B72EDDBEEC318C219B87747CE8",
	"service_request_identifier" : { "number" : "36" },
	"estimated_completion_time" :
		{
			"time_period_value"	: 16,
			"time_period_uot"	: "DAYS"
		},
	"response" : 
		{
			"category_identifier" : { "code" : "RC1.2"},
			"responded_by_identifier" : { "username" : "mpadministrator"  },
			"response_date" : "2014-12-21T12:58:39",
			"description" : "Response Description"
		},
	"temporary_resolution" : 
		{
			"category_identifier" : { "code" : "Temporary Resolution Category 1" },
			"temporary_resolved_by_identifier" : { "username" : "mpadministrator"},
			"temporary_resolution_date" : "2014-12-20T12:58:39",
			"accepted_by_identifier" : { "id_number" : "1009900" }
		},
	"final_resolution" : 
		{
			"category_identifier" : { "code" : "Final Resolution Category 1" },
			"final_resolved_by_identifier" : { "username" : "mpadministrator"},
			"final_resolution_date" : "2015-01-02T09:10:45",
			"accepted_by_identifier" : { "id_number" : "1009900" }
		},
	"services_set" :
        [
            {
                "action" : "remove",
                "service_request_service_identifier":{"product_identifier" : { "code" : "Gold" }}
            }
        ],
  "physical_goods_set":
		 [ 
			{
				"action":"remove",
				"service_request_physical_good_identifier":{"installed_item_identifier" : { "serial_number" : "222222222"}}
  }
 ]
	
}
 

 



Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "actual_completion_date": null,
           "response":
           {
               "responded_by":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "response_date": null,
               "description": "Response Description",
               "category":
               {
                   "name": "Activation problems",
                   "id": "A482BC5028AD8BB22BD8EB20EC22AE88",
                   "description": null,
                   "code": "Activat"
               }
           },
           "services_set":
           [
           ],
           "related_service_requests_set":
           [
           ],
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "36",
           "udf_float_4": null,
           "impact_level": "IMPACT3",
           "caller": null,
           "udf_string_1": null,
           "assigned_to":
           {
               "unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "udf_string_2": null,
           "estimated_completion_time":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "privacy_level": null,
           "udf_string_3": null,
           "udf_string_4": null,
           "urgency_level": "URGENCY1",
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "physical_goods_set":
           [
               {
                   "id": "E3760C6876A00EC40096651D2F93F82E",
                   "product":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "TERMED",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "Subscription Packages",
                           "id": "BC954969D3172372D498D3BB2BA590A0",
                           "description": "Subscription main packages",
                           "alternative_code": "SP"
                       },
                       "id": "5C2DCFDD743632AC57AE8147B6EE665E",
                       "description": null,
                       "code": "P1",
                       "alternative_code": "P1"
                   }
               }
           ],
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Nalitzis",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Dimitris",
                   "name": null,
                   "id": "04D07D783D3CA8C9048C95AFCF2616D6",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": null,
                       "passport_issued_by_country": null,
                       "passport_number": null,
                       "social_security_number": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": "8896541",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "105",
               "name": "Nalitzis",
               "id": "D0CC29DBEAC21FDECADB2A33DC3723CB"
           },
           "final_resolution":
           {
               "final_resolution_date": "2015-01-02T09:10:45",
               "description": null,
               "category":
               {
                   "name": "Final Resolution Category 1",
                   "id": "8DB846D0C7F59D91A1E41FDC59EE3656",
                   "description": null,
                   "code": "Final Resolution Category 1"
               }
           },
           "temporary_resolution":
           {
               "description": null,
               "temporarily_resolved_by":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "category":
               {
                   "name": "Temporary Resolution Category ",
                   "id": "BF4228F710B8661FD54F4A5EE957AE31",
                   "description": null,
                   "code": "Temporary Resolution Category 1"
               }
           },
           "id": "7DFF7EE3DE883044EFE5C461CC55B392",
           "caller_email": "calleremail@api.com",
           "udf_date_1": null,
           "udf_date_2": null,
           "priority_level": null,
           "referring_to":
           {
               "subscription":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Nalitzis",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": null,
                           "company_profile": null,
                           "title": null,
                           "type": "PERSON",
                           "first_name": "Dimitris",
                           "name": null,
                           "id": "04D07D783D3CA8C9048C95AFCF2616D6",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": null,
                               "passport_issued_by_country": null,
                               "passport_number": null,
                               "social_security_number": null,
                               "industry_sector": null,
                               "date_of_birth":
                               {
                                   "month": null,
                                   "day": null,
                                   "year": null
                               },
                               "name_day":
                               {
                                   "month": null,
                                   "day": null
                               },
                               "id_number": "8896541",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "105",
                       "name": "Nalitzis",
                       "id": "D0CC29DBEAC21FDECADB2A33DC3723CB"
                   },
                   "life_cycle_state": null,
                   "number": "S60085",
                   "type":
                   {
                       "name": "Normal Subscription",
                       "id": "6BB2B984CC9309775D06650C7493A836",
                       "description": null,
                       "alternative_code": "ST"
                   },
                   "id": "B36E0F884D57C32D3F2FF8018FF3EF21"
               },
               "job": null
           },
           "udf_date_3": null,
           "expected_completion_date": null,
           "udf_date_4": null,
           "start_date": "2014-12-18T14:19:08",
           "time_overdue":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "owned_by_group":
           {
               "community_name": null,
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "das"
           },
           "log_information":
           {
               "updated_date": "2014-12-18T14:52:32",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-12-18T14:19:08",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "status":
           {
               "name": "eee",
               "id": "007490C257B8CBFC20B44A6D61F45F09",
               "description": null,
               "alternative_code": "eee"
           },
           "life_cycle_state": "FINAL_RESOLVED",
           "type":
           {
               "name": "Service Request Type 1",
               "id": "600440718D8F1DB2E7DE7EDBA8EC06EC",
               "description": "rrr",
               "alternative_code": "rrr"
           },
           "category":
           {
               "classification": "INFORMATION",
               "name": "Activation problems",
               "id": "A482BC5028AD8BB22BD8EB20EC22AE88",
               "description": null,
               "alternative_code": null
           }
       }
} 


...