Versions Compared

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

This method returns information related with a service request. A single service request is returned by each call

Resource URL

Parameters

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 that should be returned as a result. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_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

...

This method returns information related with service requests. Multiple service requests are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(semi-optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

caller_identifier

(semi-optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

...

This method returns all service requests which are not completed and are past their expected completion time. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

...

GET service_requests/get_pending

This method returns all service requests which are not completed. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": null,
                   "description": null,
                   "category":
                   {
                       "name": "System errors",
                       "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                       "description": null,
                       "code": "Syst"
                   }
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "13",
               "udf_float_4": null,
               "impact_level": "CUSTOM5",
               "caller": null,
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Xenofontos ",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Iatrou",
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Kyriakos",
                       "name": null,
                       "id": "31260911295E70BB660EBEB0C4F941AC",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": "87878000",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "195",
                   "name": "Xenofontos",
                   "id": "5B51429862A7BCBAD60CC81982BBD45B"
               },
               "final_resolution":
               {
                   "final_resolution_date": null,
                   "description": null,
                   "category": null
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "9C2485138D28F4F89D9D7473F53C25C5",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription":
                   {
                       "accounts_receivable":
                       {
                           "account_owner":
                           {
                               "last_name": "Xenofontos ",
                               "life_cycle_state": "FINANCIAL",
                               "middle_name": "Iatrou",
                               "company_profile": null,
                               "title": null,
                               "type": "PERSON",
                               "first_name": "Kyriakos",
                               "name": null,
                               "id": "31260911295E70BB660EBEB0C4F941AC",
                               "company_name": null,
                               "demographics":
                               {
                                   "gender": "MALE",
                                   "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": "87878000",
                                   "id_issued_by_country": null,
                                   "industry": null
                               }
                           },
                           "life_cycle_state": "ACTIVE",
                           "number": "195",
                           "name": "Xenofontos",
                           "id": "5B51429862A7BCBAD60CC81982BBD45B"
                       },
                       "life_cycle_state": null,
                       "number": "S60225",
                       "type": null,
                       "id": "681905183544B0E30834B67A1AC8F634"
                   },
                   "job":
                   {
                       "accounts_receivable":
                       {
                           "account_owner":
                           {
                               "last_name": "Xenofontos ",
                               "life_cycle_state": "FINANCIAL",
                               "middle_name": "Iatrou",
                               "company_profile": null,
                               "title": null,
                               "type": "PERSON",
                               "first_name": "Kyriakos",
                               "name": null,
                               "id": "31260911295E70BB660EBEB0C4F941AC",
                               "company_name": null,
                               "demographics":
                               {
                                   "gender": "MALE",
                                   "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": "87878000",
                                   "id_issued_by_country": null,
                                   "industry": null
                               }
                           },
                           "life_cycle_state": "ACTIVE",
                           "number": "195",
                           "name": "Xenofontos",
                           "id": "5B51429862A7BCBAD60CC81982BBD45B"
                       },
                       "life_cycle_state": "PENDING",
                       "number": "262",
                       "id": "C10DFAEFB7A97AA564BADC6883CD464B",
                       "description": "test description for tags"
                   }
               },
               "udf_date_3": null,
               "expected_completion_date": "2016-12-12T13:27:06",
               "udf_date_4": null,
               "start_date": "2014-12-12T13:27:06",
               "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-12T14:38:17",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-12T13:27:06",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": "STANDARD_CHANGE",
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "alternative_code": null
               }
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "email": null
                   },
                   "response_date": "2014-12-31T17:16:54",
                   "description": "test",
                   "category":
                   {
                       "name": "Technical Problem",
                       "id": "EB1ED30F93661A9B75A9A078EA86A3FD",
                       "description": null,
                       "code": "Technic"
                   }
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "15",
               "udf_float_4": null,
               "impact_level": "CUSTOM5",
               "caller": null,
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": "CUSTOM1",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Xenofontos ",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Iatrou",
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Kyriakos",
                       "name": null,
                       "id": "31260911295E70BB660EBEB0C4F941AC",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": "87878000",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "195",
                   "name": "Xenofontos",
                   "id": "5B51429862A7BCBAD60CC81982BBD45B"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-29T17:17:40",
                   "description": null,
                   "category":
                   {
                       "name": "123",
                       "id": "A7B09F68791CBF611C6A046606B65B5F",
                       "description": null,
                       "code": null
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by":
                   {
                       "person_name": "CRM DEMO",
                       "username": "crmdemo",
                       "id": "EE45E7939403344B3AA5F7B8BAC55455",
                       "email": null
                   },
                   "category":
                   {
                       "name": "temp res 1",
                       "id": "16744837A588AD422393D3F3985C0E07",
                       "description": null,
                       "code": "temp res 1"
                   }
               },
               "id": "B8081CA1480F4F74F64E7966A6F95F28",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription":
                   {
                       "accounts_receivable":
                       {
                           "account_owner":
                           {
                               "last_name": "Xenofontos ",
                               "life_cycle_state": "FINANCIAL",
                               "middle_name": "Iatrou",
                               "company_profile": null,
                               "title": null,
                               "type": "PERSON",
                               "first_name": "Kyriakos",
                               "name": null,
                               "id": "31260911295E70BB660EBEB0C4F941AC",
                               "company_name": null,
                               "demographics":
                               {
                                   "gender": "MALE",
                                   "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": "87878000",
                                   "id_issued_by_country": null,
                                   "industry": null
                               }
                           },
                           "life_cycle_state": "ACTIVE",
                           "number": "195",
                           "name": "Xenofontos",
                           "id": "5B51429862A7BCBAD60CC81982BBD45B"
                       },
                       "life_cycle_state": null,
                       "number": "S60225",
                       "type": null,
                       "id": "681905183544B0E30834B67A1AC8F634"
                   },
                   "job":
                   {
                       "accounts_receivable":
                       {
                           "account_owner":
                           {
                               "last_name": "Xenofontos ",
                               "life_cycle_state": "FINANCIAL",
                               "middle_name": "Iatrou",
                               "company_profile": null,
                               "title": null,
                               "type": "PERSON",
                               "first_name": "Kyriakos",
                               "name": null,
                               "id": "31260911295E70BB660EBEB0C4F941AC",
                               "company_name": null,
                               "demographics":
                               {
                                   "gender": "MALE",
                                   "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": "87878000",
                                   "id_issued_by_country": null,
                                   "industry": null
                               }
                           },
                           "life_cycle_state": "ACTIVE",
                           "number": "195",
                           "name": "Xenofontos",
                           "id": "5B51429862A7BCBAD60CC81982BBD45B"
                       },
                       "life_cycle_state": "PENDING",
                       "number": "263",
                       "id": "EDF32FF51341E5FE6CFA22A4CE0EC4BB",
                       "description": null
                   }
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-31T17:16:12",
               "udf_date_4": null,
               "start_date": "2014-12-12T17:15:34",
               "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-12T17:20:04",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-12T17:15:34",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": "ADVICE",
                   "name": "Technical Problem",
                   "id": "EB1ED30F93661A9B75A9A078EA86A3FD",
                   "description": null,
                   "alternative_code": null
               }
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": "2014-12-16T12:02:58",
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "11",
               "udf_float_4": null,
               "impact_level": null,
               "caller": null,
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Xenofontos ",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Iatrou",
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Kyriakos",
                       "name": null,
                       "id": "31260911295E70BB660EBEB0C4F941AC",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": "87878000",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "195",
                   "name": "Xenofontos",
                   "id": "5B51429862A7BCBAD60CC81982BBD45B"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-15T16:31:06",
                   "description": null,
                   "category":
                   {
                       "name": "123",
                       "id": "A7B09F68791CBF611C6A046606B65B5F",
                       "description": null,
                       "code": null
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by":
                   {
                       "person_name": "Marios Lannister",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "category": null
               },
               "id": "DBB394D7C3FC60A4954EF16875F67254",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2016-12-12T09:21:13",
               "udf_date_4": null,
               "start_date": "2014-12-12T09:21:13",
               "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-16T12:15:18",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-12T09:21:13",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": "STANDARD_CHANGE",
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "alternative_code": null
               }
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": null,
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "12",
               "udf_float_4": null,
               "impact_level": null,
               "caller": null,
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Xenofontos ",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Iatrou",
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Kyriakos",
                       "name": null,
                       "id": "31260911295E70BB660EBEB0C4F941AC",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": "87878000",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "195",
                   "name": "Xenofontos",
                   "id": "5B51429862A7BCBAD60CC81982BBD45B"
               },
               "final_resolution":
               {
                   "final_resolution_date": null,
                   "description": null,
                   "category": null
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "A74F8206C70E7C9C9D2B1AE656DAF6C6",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-26T12:53:40",
               "udf_date_4": null,
               "start_date": "2014-12-12T12:53:40",
               "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-12T12:57:43",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-12T12:53:40",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": null
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "email": null
                   },
                   "response_date": null,
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "17",
               "udf_float_4": null,
               "impact_level": null,
               "caller":
               {
                   "last_name": "TC219A",
                   "life_cycle_state": "MARKETING",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "TC219A",
                   "name": null,
                   "id": "7AC4E3186CF790EB1F8E14E20F34C2FF",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": null,
                       "passport_issued_by_country": null,
                       "passport_number": null,
                       "social_security_number": null,
                       "country_of_residence": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 0,
                           "day": 0,
                           "year": 0
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": null,
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Xenofontos ",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Iatrou",
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Kyriakos",
                       "name": null,
                       "id": "31260911295E70BB660EBEB0C4F941AC",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": "87878000",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "195",
                   "name": "Xenofontos",
                   "id": "5B51429862A7BCBAD60CC81982BBD45B"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-30T12:51:34",
                   "description": null,
                   "category":
                   {
                       "name": "123",
                       "id": "A7B09F68791CBF611C6A046606B65B5F",
                       "description": null,
                       "code": null
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "D0A8EF7E617506223011C66932C2F50D",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-19T17:36:46",
               "udf_date_4": null,
               "start_date": "2014-12-12T17:36:28",
               "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-15T20:30:48",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-12T17:36:28",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": "ADVICE",
                   "name": "Technical Problem",
                   "id": "EB1ED30F93661A9B75A9A078EA86A3FD",
                   "description": null,
                   "alternative_code": null
               }
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": null,
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "18",
               "udf_float_4": null,
               "impact_level": "CUSTOM5",
               "caller": null,
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Panagi",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Dimitris",
                       "name": null,
                       "id": "F571388410090459E7C72D17E02D2D3F",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": null,
                           "social_security_number": null,
                           "country_of_residence": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "9",
                   "name": "Panagi",
                   "id": "18446358B7C1F1550850B600DBC1F808"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-30T12:46:23",
                   "description": null,
                   "category":
                   {
                       "name": "123",
                       "id": "A7B09F68791CBF611C6A046606B65B5F",
                       "description": null,
                       "code": null
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "9502A63EA2A9D857E47744685D5D9B89",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2016-12-15T12:37:44",
               "udf_date_4": null,
               "start_date": "2014-12-15T12:37:44",
               "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": "CSR Group",
                   "id": "9F53AE96144CB2F358C38BADE9E2F470",
                   "description": null,
                   "alternative_code": "CSR"
               },
               "log_information":
               {
                   "updated_date": "2014-12-15T12:46:44",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-12-15T12:37:44",
                   "updated_by_unit":
                   {
                       "community_name": null,
                       "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": "MPAdministrator",
                       "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": null
           },
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": null,
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "19",
               "udf_float_4": null,
               "impact_level": "IMPACT1",
               "caller":
               {
                   "last_name": "Xenofontos ",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "Iatrou",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Kyriakos",
                   "name": null,
                   "id": "31260911295E70BB660EBEB0C4F941AC",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "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": "87878000",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": "URGENCY3",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Panagi",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Dimitris",
                       "name": null,
                       "id": "F571388410090459E7C72D17E02D2D3F",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": null,
                           "social_security_number": null,
                           "country_of_residence": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "9",
                   "name": "Panagi",
                   "id": "18446358B7C1F1550850B600DBC1F808"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-16T16:51:35",
                   "description": null,
                   "category":
                   {
                       "name": "123",
                       "id": "A7B09F68791CBF611C6A046606B65B5F",
                       "description": null,
                       "code": null
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "5E376E9D2E5DE7E93423743B64A94842",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": null,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-16T09:23:33",
               "udf_date_4": null,
               "start_date": "2014-12-15T16:43:33",
               "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-15T17:39:50",
                   "created_by_unit":
                   {
                       "community_name": null,
                       "group_name": "Main Group",
 

GET service_requests/get_close_to_estimated_completion_time

Tip

Available from CRM.COM R11.1.0

This method returns all service requests which are close to estimated completion time. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

period
(mandatory)

identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Name

Type

Description

token

String

The token retrieved from the login method

 period
(mandatory)
NumberThe length of time for which an activity a service request is close to estimated completion

uot
(mandatory)

StringThe unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier
 caller

fields_

set

(optional)

Contact information identifier
Include Page
v4:contact_information_identifierv4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_

category_identifier

complete
V4:service_request_

category_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

complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
 

 

GET service_requests/get_responded

This method returns all service requests which are in life cycle state "Responded". Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": null
                   },
                   "response_date": "2014-12-20T12:58:39",
                   "description": "Response Description",
                   "category":
                   {
                       "name": "Channel A",
                       "id": "D9AB84B843F3160E95F9131A9CE42B6D",
                       "description": "Channel A",
                       "code": "CHNL"
                   }
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "37",
               "udf_float_4": null,
               "impact_level": "IMPACT3",
               "caller":
               {
                   "last_name": "Markidou",
                   "life_cycle_state": "MARKETING",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Maria",
                   "name": null,
                   "id": "D09AC9B3D543AC7B45A4163BDD78DBD3",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "FEMALE",
                       "passport_issued_by_country": null,
                       "passport_number": null,
                       "social_security_number": "124578",
                       "country_of_residence": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": "778800457",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "user": 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": "URGENCY3",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Markidou",
                       "life_cycle_state": "MARKETING",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Maria",
                       "name": null,
                       "id": "D09AC9B3D543AC7B45A4163BDD78DBD3",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "FEMALE",
                           "passport_issued_by_country": null,
                           "passport_number": null,
                           "social_security_number": "124578",
                           "country_of_residence": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": "778800457",
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "19",
                   "name": "Maria Markidou",
                   "id": "74E98CED240CDC2BF8BD697161227A2C"
               },
               "final_resolution":
               {
                   "final_resolution_date": null,
                   "description": null,
                   "category": null
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by": null,
                   "category": null
               },
               "id": "A111D7FE7ACF8489C2D82EB13E740B23",
               "caller_email": "D00BC61F9D0D4463959985112A3A3DC7",
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": 9,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-28T16:13:38",
               "udf_date_4": null,
               "start_date": "2014-12-18T16:13:38",
               "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": "Developers Group",
                   "id": "8BD400EC50DB9678F9C3573401399924",
                   "description": "test2",
                   "alternative_code": null
               },
               "status":
               {
                   "name": "Responded 1",
                   "id": "BC2C1CF4F4764FF4CFEADDD5E0D41E68",
                   "description": null,
                   "alternative_code": "R1"
               },
               "life_cycle_state": "RESPONDED",
               "type":
               {
                   "name": "SR Type",
                   "id": "78458F41D4260AA148181BF0D8B5602D",
                   "description": null,
                   "alternative_code": "SRT"
               },
               "category":
               {
                   "classification": "INFORMATION",
                   "name": "Channel A",
                   "id": "D9AB84B843F3160E95F9131A9CE42B6D",
                   "description": "Channel A",
                   "alternative_code": null
               }
           }
       ]
  } 

GET service_requests/get_responded_pending_acceptance

Tip

Available from CRM.COM R9.0.0

This method returns all service requests which are in state "Responded" and are still pending acceptance, considering that the specified response category requires customer acceptance. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "actual_completion_date": null,
            "response":
            {
                "responded_by":
                {
                    "person_name": "crmdemo",
                    "username": "crmdemo",
                    "id": "EE45E7939403344B3AA5F7B8BAC55455",
                    "email": null
                },
                "description": null,
                "response_date": "2015-04-29T10:59:50",
                "category":
                {
                    "requires_customer_acceptance": true,
                    "id": "AB9574217CF96FE7FC5B2A134EF1ADC9",
                    "name": "Approved for Resolution",
                    "description": null,
                    "code": "AFR"
                },
                "accepted_by": null
            },
            "services_set":
            [
            ],
            "related_service_requests_set":
            [
            ],
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "NSR000044",
            "impact_level": "IMPACT1",
            "udf_string_1": null,
            "caller":
            {
                "last_name": "Mercer",
                "middle_name": "111111111",
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": "Mr",
                "first_name": "Ben11 omonoia",
                "type": "PERSON",
                "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
                "name": "Mercer Ben11 omonoia",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "name_day":
                    {
                        "month": 6,
                        "day": 14
                    },
                    "date_of_birth":
                    {
                        "month": 11,
                        "day": 9,
                        "year": 1963
                    },
                    "id_number": "1212125"
                }
            },
            "assigned_to":
            {
                "unit":
                {
                    "id": "4677F5B24AC600DF7476F003DA185FAE",
                    "name": "Operators SB1",
                    "group_name": "Sales Branch 1",
                    "description": null,
                    "alternative_code": "OSB1"
                },
                "user": null
            },
            "udf_string_2": null,
            "privacy_level": null,
            "estimated_completion_time":
            {
                "time_period_value": 20,
                "time_period_uot": "MINUTES"
            },
            "udf_string_3": null,
            "urgency_level": "URGENCY1",
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "physical_goods_set":
            [
            ],
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Mercer",
                    "middle_name": "111111111",
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": "Mr",
                    "first_name": "Ben11 omonoia",
                    "type": "PERSON",
                    "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
                    "name": "Mercer Ben11 omonoia",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "name_day":
                        {
                            "month": 6,
                            "day": 14
                        },
                        "date_of_birth":
                        {
                            "month": 11,
                            "day": 9,
                            "year": 1963
                        },
                        "id_number": "1212125"
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "162",
                "id": "3C66BD54CCDB6BC1096C23F6D8899752",
                "name": "Ben Mercer 1"
            },
            "final_resolution":
            {
                "finally_resolved_by": null,
                "final_resolution_date": null,
                "description": null,
                "category": null,
                "accepted_by": null
            },
            "temporary_resolution":
            {
                "description": null,
                "temporarily_resolved_by": null,
                "category": null,
                "accepted_by": null
            },
            "id": "0A80515C2111425CB728DC7EFE991760",
            "udf_date_1": null,
            "caller_email": "mariosmichael88@gmail.com",
            "udf_date_2": null,
            "priority_level": 1,
            "udf_date_3": null,
            "expected_completion_date": "2015-04-29T11:15:39",
            "referring_to":
            {
                "job": null,
                "subscription": null
            },
            "start_date": "2015-04-29T10:55:39",
            "udf_date_4": null,
            "time_to_completion":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "time_overdue":
            {
                "time_period_value": 8.195698924731182,
                "time_period_uot": "MONTHS"
            },
            "owned_by_group":
            {
                "id": "FECAEF5B0730FC9654AC10465B25D8D6",
                "name": "Admin Group",
                "description": null,
                "alternative_code": "AG"
            },
            "log_information":
            {
                "updated_date": "2015-04-29T10:59:58",
                "created_date": "2015-04-29T10:55:39",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "3719E9998E567A788A865CD1B4556821",
                "name": "Assigned",
                "description": "Assigned",
                "alternative_code": "ASG"
            },
            "life_cycle_state": "RESPONDED",
            "type":
            {
                "id": "C0014B5217E42FCF43100373A17E9A6E",
                "name": "Request for Change",
                "description": null,
                "alternative_code": "RFC"
            },
            "category":
            {
                "classification": "ADVICE",
                "id": "E99CB6E1D075857EB7DE9985782F577F",
                "name": "Difficult",
                "description": "Difficult",
                "code": "ADV_DFCT"
            }
        },
        {
            "actual_completion_date": null,
            "response":
            {
                "responded_by":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "description": null,
                "response_date": "2015-07-20T15:58:04",
                "category":
                {
					"requires_customer_acceptance": false,
                    "id": "73BF512136DB35FE56A60ABF5DF5A91C",
                    "name": "Assigned",
                    "description": "Assigned SR",
                    "code": "ASN"
                },
                "accepted_by": null
            },
            "services_set":
            [
            ],
            "related_service_requests_set":
            [
            ],
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "NSR000086",
            "impact_level": "IMPACT1",
            "udf_string_1": null,
            "caller":
            {
                "last_name": "Cartman",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": "Mr",
                "first_name": "Eric",
                "type": "PERSON",
                "id": "A0677C31014B046867A78BA8D63AC4BD",
                "name": "Cartman Eric",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": "984683",
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "assigned_to":
            {
                "unit":
                {
                    "id": "4677F5B24AC600DF7476F003DA185FAE",
                    "name": "Operators SB1",
                    "group_name": "Sales Branch 1",
                    "description": null,
                    "alternative_code": "OSB1"
                },
                "user": null
            },
            "udf_string_2": null,
            "privacy_level": null,
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "HOURS"
            },
            "udf_string_3": null,
            "urgency_level": "URGENCY1",
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "physical_goods_set":
            [
            ],
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Cartman",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": "Mr",
                    "first_name": "Eric",
                    "type": "PERSON",
                    "id": "A0677C31014B046867A78BA8D63AC4BD",
                    "name": "Cartman Eric",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "984683",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "200",
                "id": "4874AFB2316FD3D3A58F4A028DAEF7F3",
                "name": "Cartman Std"
            },
            "final_resolution":
            {
                "finally_resolved_by": null,
                "final_resolution_date": null,
                "description": null,
                "category": null,
                "accepted_by": null
            },
            "temporary_resolution":
            {
                "description": null,
                "temporarily_resolved_by": null,
                "category": null,
                "accepted_by": null
            },
            "id": "1BA83AB560BF470AB7B13EB992E6EA2C",
            "udf_date_1": null,
            "caller_email": "se.aya@hotmail.com",
            "udf_date_2": null,
            "priority_level": 1,
            "udf_date_3": null,
            "expected_completion_date": "2015-07-20T17:57:53",
            "referring_to":
            {
                "job": null,
                "subscription": null
            },
            "start_date": "2015-07-20T15:57:53",
            "udf_date_4": null,
            "time_to_completion":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "time_overdue":
            {
                "time_period_value": 5.516129032258064,
                "time_period_uot": "MONTHS"
            },
            "owned_by_group":
            {
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "name": "Main Group",
                "description": "Main Group",
                "alternative_code": "MG1"
            },
            "log_information":
            {
                "updated_date": "2015-07-20T15:59:18",
                "created_date": "2015-07-20T15:57:53",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "3719E9998E567A788A865CD1B4556821",
                "name": "Assigned",
                "description": "Assigned",
                "alternative_code": "ASG"
            },
            "life_cycle_state": "RESPONDED",
            "type":
            {
                "id": "3E19C42A76820EFEF54DB4F103DC1BFC",
                "name": "Information",
                "description": null,
                "alternative_code": "I"
            },
            "category":
            {
                "classification": "INFORMATION",
                "id": "611D6BAE4B568615F8D2727E4B55E270",
                "name": "Credentials",
                "description": "Credentials",
                "code": "INF_CRTL"
            }
        },
....
   }
 ]
} 

...

This method returns all service requests which are in life cycle state "Temporary Resolved". Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": null,
                   "description": null,
                   "category": null
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "40",
               "udf_float_4": null,
               "impact_level": "IMPACT3",
               "caller":
               {
                   "last_name": "Ioannou5",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Marios",
                   "name": null,
                   "id": "EE44F19F055556200505CBF21F61608D",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "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": null,
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Developers Unit",
                       "id": "C4370788B2630BC8A99E8C7397406C09",
                       "description": null,
                       "alternative_code": null
                   },
                   "user":
                   {
                       "person_name": "x_poulli",
                       "username": "x_poulli",
                       "id": "D0B5657F42ED3331694BAE21DF971807",
                       "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": "URGENCY3",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Ioannou5",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Marios",
                       "name": null,
                       "id": "EE44F19F055556200505CBF21F61608D",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "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": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "24",
                   "name": "mar_5",
                   "id": "F03236758EB0AD85518F17192B6AA65E"
               },
               "final_resolution":
               {
                   "final_resolution_date": null,
                   "description": null,
                   "category": null
               },
               "temporary_resolution":
               {
                   "description": "test",
                   "temporarily_resolved_by":
                   {
                       "person_name": "Simon Browndasda",
                       "username": "DELBOY",
                       "id": "29DE94EBF89A885822BAB8179F2F2686",
                       "email": null
                   },
                   "category":
                   {
                       "name": "temp",
                       "id": "D7BB37967FFE45D7FD4F802648806991",
                       "description": "tt",
                       "code": "tt"
                   }
               },
               "id": "D7C8BF3F6AB9EEEEDBEC0D1307D19E7A",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": 9,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-26T09:40:57",
               "udf_date_4": null,
               "start_date": "2014-12-19T09:40:57",
               "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"
               },
               "status":
               {
                   "name": "Temporary Resolved",
                   "id": "05E679983BF06916793DC2617A21FCD1",
                   "description": null,
                   "alternative_code": "TEMP_RES"
               },
               "life_cycle_state": "TEMPORARY_RESOLVED",
               "type":
               {
                   "name": "Service Request Type",
                   "id": "0DC7C27F29128F502F58EFD2CFA6B6FB",
                   "description": "test type",
                   "alternative_code": "SRT_1"
               },
               "category":
               {
                   "classification": "STANDARD_CHANGE",
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "alternative_code": null
               }
           }
       ]
} 

...

This method returns all service requests which are in state "Temporary Resolved" and are still pending acceptance. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "actual_completion_date": null,
               "response":
               {
                   "responded_by": null,
                   "response_date": "2014-12-27T11:28:53",
                   "description": null,
                   "category":
                   {
                       "name": "System errors",
                       "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                       "description": null,
                       "code": "Syst"
                   }
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "43",
               "udf_float_4": null,
               "impact_level": "IMPACT3",
               "caller":
               {
                   "last_name": "Spector",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Matt",
                   "name": null,
                   "id": "58F5508072753180E10322DBCA1862EE",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "passport_issued_by_country": null,
                       "passport_number": "JB0007689",
                       "social_security_number": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": null,
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Marketing Unit",
                       "id": "83922FE923563679768A94F58CAB5569",
                       "description": "r1c1",
                       "alternative_code": null
                   },
                   "user": 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": "URGENCY3",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Spector",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Matt",
                       "name": null,
                       "id": "58F5508072753180E10322DBCA1862EE",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": "JB0007689",
                           "social_security_number": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "96",
                   "name": "Matt Spector",
                   "id": "F531318F7F082F3A329E57728BC63695"
               },
               "final_resolution":
               {
                   "final_resolution_date": null,
                   "description": null,
                   "category": null
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by":
                   {
                       "person_name": "Super Visor",
                       "username": "supervisor",
                       "id": "018CA08BC267612F6206D85011FFC5D1",
                       "email": "super@visor.com"
                   },
                   "category":
                   {
                       "name": "temp",
                       "id": "D7BB37967FFE45D7FD4F802648806991",
                       "description": "tt",
                       "code": "tt"
                   }
               },
               "id": "2801305EDE664F5188468154DED358FC",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": 9,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-29T11:27:30",
               "udf_date_4": null,
               "start_date": "2014-12-27T11:27:30",
               "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": "Collaboration Group 1",
                   "id": "F2992C3F2976F6B80D1F236628916141",
                   "description": null,
                   "alternative_code": "CG1"
               },
               "status":
               {
                   "name": "Temporary Resolved",
                   "id": "05E679983BF06916793DC2617A21FCD1",
                   "description": null,
                   "alternative_code": "TEMP_RES"
               },
               "life_cycle_state": "TEMPORARY_RESOLVED",
               "type":
               {
                   "name": "Service Request Type",
                   "id": "0DC7C27F29128F502F58EFD2CFA6B6FB",
                   "description": "test type",
                   "alternative_code": "SRT_1"
               },
               "category":
               {
                   "classification": "STANDARD_CHANGE",
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "alternative_code": null
               }
           }
       ]
}

GET service_requests/get_final_resolved

This method returns all service requests which are in life cycle state "Final Resolved". Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "actual_completion_date": null,
            "response":
            {
                "responded_by": null,
                "response_date": null,
                "description": null,
                "category": null
            },
            "services_set":
            [
            ],
            "related_service_requests_set":
            [
            ],
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "41",
            "udf_float_4": null,
            "impact_level": "IMPACT3",
            "caller":
            {
                "last_name": "Georgiou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Miss",
                "type": "PERSON",
                "first_name": "Michalis1",
                "name": "Michalis1 Georgiou",
                "id": "02B4928EE8C9A170F888264D686927DD",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country": null,
                    "passport_number": "123456789",
                    "social_security_number": "45545123",
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "454545",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "udf_string_1": null,
            "assigned_to":
            {
                "unit":
                {
                    "name": "Developers Unit",
                    "id": "C4370788B2630BC8A99E8C7397406C09",
                    "description": null,
                    "alternative_code": null
                },
                "user":
                {
                    "person_name": "x_poulli",
                    "username": "x_poulli",
                    "id": "D0B5657F42ED3331694BAE21DF971807"
                }
            },
            "udf_string_2": null,
            "estimated_completion_time":
            {
                "time_period_value": 1,
                "time_period_uot": "WEEKS"
            },
            "privacy_level": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "urgency_level": "URGENCY3",
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "physical_goods_set":
            [
            ],
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Georgiou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Miss",
                    "type": "PERSON",
                    "first_name": "Michalis1",
                    "name": "Michalis1 Georgiou",
                    "id": "02B4928EE8C9A170F888264D686927DD",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "passport_number": "123456789",
                        "social_security_number": "45545123",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "454545",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "25",
                "name": "Persy Xen 1",
                "id": "4D5FC73366965D25D725289941A3B4F3"
            },
            "final_resolution":
            {
                "finally_resolved_by":
                {
                    "person_name": "hannibal",
                    "username": "hannibal",
                    "id": "2C008EB82E0DBC7722E93F207E2091CE"
                },
                "final_resolution_date": "2014-12-30T09:50:26",
                "description": null,
                "category":
                {
                    "name": "new",
                    "id": "8665BD898737C484F49146B05506EBE6",
                    "description": null,
                    "code": "NN"
                },
                "accepted_by":
                {
                    "last_name": "Testing",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "myInstall1",
                    "name": "myInstall1 Testing",
                    "id": "08770EB5E378132B918097DBE1C64923",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence": null,
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 2,
                            "day": 1,
                            "year": 1324
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                }
            },
            "temporary_resolution":
            {
                "description": "ff",
                "temporarily_resolved_by": null,
                "category": null,
                "accepted_by": null
            },
            "id": "F68ACE047A967D7A2BCD81FA76234C58",
            "caller_email": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "priority_level": 9,
            "referring_to":
            {
                "subscription": null,
                "job": null
            },
            "udf_date_3": null,
            "expected_completion_date": "2014-12-26T09:50:01",
            "udf_date_4": null,
            "start_date": "2014-12-19T09:49:30",
            "time_overdue":
            {
                "time_period_value": 2.0506912442396312,
                "time_period_uot": "MONTHS"
            },
            "time_to_completion":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "owned_by_group":
            {
                "name": "Main Group",
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "description": "Main Group",
                "alternative_code": "das"
            },
            "log_information":
            {
                "updated_date": "2014-12-19T09:51:44",
                "created_by_unit":
                {
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-12-19T09:49:30",
                "updated_by_unit":
                {
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "status":
            {
                "name": "Final Resolved",
                "id": "C01A1977A02AC720B4447C359FEB8D1A",
                "description": null,
                "alternative_code": "FIN_RES"
            },
            "life_cycle_state": "FINAL_RESOLVED",
            "type":
            {
                "name": "Service Request Type",
                "id": "0DC7C27F29128F502F58EFD2CFA6B6FB",
                "description": "test type",
                "alternative_code": "SRT_1"
            },
            "category":
            {
                "classification": "STANDARD_CHANGE",
                "name": "System errors",
                "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                "description": null,
                "code": null
            }
        },              
.....
}

 

GET service_requests/get_final_resolved_pending_acceptance

This method returns all service requests which are in life cycle state "Final Resolved" and pending acceptance. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "actual_completion_date": null,
           "response":
           {
               "responded_by": null,
               "response_date": null,
               "description": null,
               "category":
               {
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "code": "Syst"
               }
           },
           "services_set":
           [
           ],
           "related_service_requests_set":
           [
           ],
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "13",
           "udf_float_4": null,
           "impact_level": "CUSTOM5",
           "caller": null,
           "udf_string_1": null,
           "assigned_to":
           {
               "unit":
               {
                   "group_name": null,
                   "name": "Developers Unit",
                   "id": "C4370788B2630BC8A99E8C7397406C09",
                   "description": null,
                   "alternative_code": null
               },
               "user":
               {
                   "person_name": "x_poulli",
                   "username": "x_poulli",
                   "id": "D0B5657F42ED3331694BAE21DF971807",
                   "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": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "physical_goods_set":
           [
           ],
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Xenofontos ",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "Iatrou",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Kyriakos",
                   "name": null,
                   "id": "31260911295E70BB660EBEB0C4F941AC",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "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": "87878000",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "195",
               "name": "Xenofontos",
               "id": "5B51429862A7BCBAD60CC81982BBD45B"
           },
           "final_resolution":
           {
               "final_resolution_date": null,
               "description": null,
               "category": null
           },
           "temporary_resolution":
           {
               "description": null,
               "temporarily_resolved_by": null,
               "category": null
           },
           "id": "9C2485138D28F4F89D9D7473F53C25C5",
           "caller_email": null,
           "udf_date_1": null,
           "udf_date_2": null,
           "priority_level": null,
           "referring_to":
           {
               "subscription":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Xenofontos ",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "Iatrou",
                           "company_profile": null,
                           "title": null,
                           "type": "PERSON",
                           "first_name": "Kyriakos",
                           "name": null,
                           "id": "31260911295E70BB660EBEB0C4F941AC",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "MALE",
                               "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": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "195",
                       "name": "Xenofontos",
                       "id": "5B51429862A7BCBAD60CC81982BBD45B"
                   },
                   "life_cycle_state": null,
                   "number": "S60225",
                   "type": null,
                   "id": "681905183544B0E30834B67A1AC8F634"
               },
               "job":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Xenofontos ",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "Iatrou",
                           "company_profile": null,
                           "title": null,
                           "type": "PERSON",
                           "first_name": "Kyriakos",
                           "name": null,
                           "id": "31260911295E70BB660EBEB0C4F941AC",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "MALE",
                               "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": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "195",
                       "name": "Xenofontos",
                       "id": "5B51429862A7BCBAD60CC81982BBD45B"
                   },
                   "life_cycle_state": "PENDING",
                   "number": "262",
                   "id": "C10DFAEFB7A97AA564BADC6883CD464B",
                   "description": "test description for tags"
               }
           },
           "udf_date_3": null,
           "expected_completion_date": "2016-12-12T13:27:06",
           "udf_date_4": null,
           "start_date": "2014-12-12T13:27:06",
           "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-12T14:38:17",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-12-12T13:27:06",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "MPAdministrator",
                   "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": "STANDARD_CHANGE",
               "name": "System errors",
               "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
               "description": null,
               "alternative_code": null
           }
       },
       {
           "actual_completion_date": null,
           "response":
           {
               "responded_by":
               {
                   "person_name": "x_poulli",
                   "username": "x_poulli",
                   "id": "D0B5657F42ED3331694BAE21DF971807",
                   "email": null
               },
               "response_date": "2014-12-31T17:16:54",
               "description": "test",
               "category":
               {
                   "name": "Technical Problem",
                   "id": "EB1ED30F93661A9B75A9A078EA86A3FD",
                   "description": null,
                   "code": "Technic"
               }
           },
           "services_set":
           [
           ],
           "related_service_requests_set":
           [
           ],
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "15",
           "udf_float_4": null,
           "impact_level": "CUSTOM5",
           "caller": null,
           "udf_string_1": null,
           "assigned_to":
           {
               "unit":
               {
                   "group_name": null,
                   "name": "Developers Unit",
                   "id": "C4370788B2630BC8A99E8C7397406C09",
                   "description": null,
                   "alternative_code": null
               },
               "user":
               {
                   "person_name": "x_poulli",
                   "username": "x_poulli",
                   "id": "D0B5657F42ED3331694BAE21DF971807",
                   "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": "CUSTOM1",
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "physical_goods_set":
           [
           ],
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Xenofontos ",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "Iatrou",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Kyriakos",
                   "name": null,
                   "id": "31260911295E70BB660EBEB0C4F941AC",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "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": "87878000",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "195",
               "name": "Xenofontos",
               "id": "5B51429862A7BCBAD60CC81982BBD45B"
           },
           "final_resolution":
           {
               "final_resolution_date": "2014-12-29T17:17:40",
               "description": null,
               "category":
               {
                   "name": "123",
                   "id": "A7B09F68791CBF611C6A046606B65B5F",
                   "description": null,
                   "code": null
               }
           },
           "temporary_resolution":
           {
               "description": null,
               "temporarily_resolved_by":
               {
                   "person_name": "CRM DEMO",
                   "username": "crmdemo",
                   "id": "EE45E7939403344B3AA5F7B8BAC55455",
                   "email": null
               },
               "category":
               {
                   "name": "temp res 1",
                   "id": "16744837A588AD422393D3F3985C0E07",
                   "description": null,
                   "code": "temp res 1"
               }
           },
           "id": "B8081CA1480F4F74F64E7966A6F95F28",
           "caller_email": null,
           "udf_date_1": null,
           "udf_date_2": null,
           "priority_level": null,
           "referring_to":
           {
               "subscription":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Xenofontos ",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "Iatrou",
                           "company_profile": null,
                           "title": null,
                           "type": "PERSON",
                           "first_name": "Kyriakos",
                           "name": null,
                           "id": "31260911295E70BB660EBEB0C4F941AC",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "MALE",
                               "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": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "195",
                       "name": "Xenofontos",
                       "id": "5B51429862A7BCBAD60CC81982BBD45B"
                   },
                   "life_cycle_state": null,
                   "number": "S60225",
                   "type": null,
                   "id": "681905183544B0E30834B67A1AC8F634"
               },
               "job":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Xenofontos ",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "Iatrou",
                           "company_profile": null,
                           "title": null,
                           "type": "PERSON",
                           "first_name": "Kyriakos",
                           "name": null,
                           "id": "31260911295E70BB660EBEB0C4F941AC",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "MALE",
                               "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": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "195",
                       "name": "Xenofontos",
                       "id": "5B51429862A7BCBAD60CC81982BBD45B"
                   },
                   "life_cycle_state": "PENDING",
                   "number": "263",
                   "id": "EDF32FF51341E5FE6CFA22A4CE0EC4BB",
                   "description": null
               }
           },
           "udf_date_3": null,
           "expected_completion_date": "2014-12-31T17:16:12",
           "udf_date_4": null,
           "start_date": "2014-12-12T17:15:34",
           "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-12T17:20:04",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-12-12T17:15:34",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "MPAdministrator",
                   "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": "ADVICE",
               "name": "Technical Problem",
               "id": "EB1ED30F93661A9B75A9A078EA86A3FD",
               "description": null,
               "alternative_code": null
           }
       }
} 

 

GET service_requests/get_completed

This method returns all service requests which are completed. Multiple service requests are returned by each call. Note that identifiers are optional for this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the service requests that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Service request type identifier

The identifier of the service request type related with the service requests that should be returned as a result. The allowed service request type identifier fields are the following:

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

 caller_identifier

(optional)

Contact information identifier

The identifier of the caller related with the service requests that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

category_identifier

(optional)

Service Request Category Identifier

The identifier of the category related with the service requests that should be returned as a result. The allowed service request category identifier fields are the following:

Include Page
V4:service_request_category_identifier
V4:service_request_category_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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "actual_completion_date": "2014-12-19T12:46:31",
               "response":
               {
                   "responded_by": null,
                   "response_date": "2014-12-27T11:28:53",
                   "description": null,
                   "category":
                   {
                       "name": "System errors",
                       "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                       "description": null,
                       "code": "Syst"
                   }
               },
               "services_set":
               [
               ],
               "related_service_requests_set":
               [
               ],
               "udf_float_1": null,
               "udf_float_2": null,
               "udf_float_3": null,
               "number": "43",
               "udf_float_4": null,
               "impact_level": "IMPACT3",
               "caller":
               {
                   "last_name": "Spector",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Matt",
                   "name": null,
                   "id": "58F5508072753180E10322DBCA1862EE",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "passport_issued_by_country": null,
                       "passport_number": "JB0007689",
                       "social_security_number": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": null,
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_1": null,
               "assigned_to":
               {
                   "unit":
                   {
                       "group_name": null,
                       "name": "Marketing Unit",
                       "id": "83922FE923563679768A94F58CAB5569",
                       "description": "r1c1",
                       "alternative_code": null
                   },
                   "user": 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": "URGENCY3",
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "physical_goods_set":
               [
               ],
               "udf_string_8": null,
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Spector",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Matt",
                       "name": null,
                       "id": "58F5508072753180E10322DBCA1862EE",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": "JB0007689",
                           "social_security_number": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "96",
                   "name": "Matt Spector",
                   "id": "F531318F7F082F3A329E57728BC63695"
               },
               "final_resolution":
               {
                   "final_resolution_date": "2014-12-28T12:58:39",
                   "description": "Response Description",
                   "category":
                   {
                       "name": "new",
                       "id": "8665BD898737C484F49146B05506EBE6",
                       "description": null,
                       "code": "NN"
                   }
               },
               "temporary_resolution":
               {
                   "description": null,
                   "temporarily_resolved_by":
                   {
                       "person_name": "Super Visor",
                       "username": "supervisor",
                       "id": "018CA08BC267612F6206D85011FFC5D1",
                       "email": "super@visor.com"
                   },
                   "category":
                   {
                       "name": "temp",
                       "id": "D7BB37967FFE45D7FD4F802648806991",
                       "description": "tt",
                       "code": "tt"
                   }
               },
               "id": "2801305EDE664F5188468154DED358FC",
               "caller_email": null,
               "udf_date_1": null,
               "udf_date_2": null,
               "priority_level": 9,
               "referring_to":
               {
                   "subscription": null,
                   "job": null
               },
               "udf_date_3": null,
               "expected_completion_date": "2014-12-29T11:27:30",
               "udf_date_4": null,
               "start_date": "2014-12-27T11:27:30",
               "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": "Collaboration Group 1",
                   "id": "F2992C3F2976F6B80D1F236628916141",
                   "description": null,
                   "alternative_code": "CG1"
               },
               "status":
               {
                   "name": "Completed",
                   "id": "C59D6A61EC8D9326C57799272BD92264",
                   "description": "COMPLETE",
                   "alternative_code": "CMPL"
               },
               "life_cycle_state": "COMPLETED",
               "type":
               {
                   "name": "Service Request Type",
                   "id": "0DC7C27F29128F502F58EFD2CFA6B6FB",
                   "description": "test type",
                   "alternative_code": "SRT_1"
               },
               "category":
               {
                   "classification": "STANDARD_CHANGE",
                   "name": "System errors",
                   "id": "F560F4FB7CABF49DE98BCEBD2273F85B",
                   "description": null,
                   "alternative_code": null
               }
           }
       ]
}

 

...

This method creates a service request  Single service requests can be created by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

(mandatory)

Service Request Type Identifier

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

Include Page
V4:service_request_type_identifier
V4:service_request_type_identifier

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The accounts receivable that will be related with the service request. The allowed accounts receivable identifier fields are the following:

Include Page
v4:accounts_receivable_identifier
v4:accounts_receivable_identifier

contact_information_identifier

(optional)

Contact Information Identifier

The contact information that raised the service request. The contact information should be the accounts receivable owner or a contact information related with the accounts receivable owner. If not specified it is automatically set to the accounts owner. The allowed contact information identifier fields are the following:

Include Page
v4:contact_information_identifier
v4:contact_information_identifier

caller_email

(mandatory on conditions)

Sting

The email of the caller. This information is mandatory if the service requests definition is configured to automatically email customers upon changes of their service requests statuses

Tip

From CRM.COM R10.0.0 the caller_email is optional since the service request's status change might also be communicated to the customer through an SMS message.

caller_phone

(optional)

Sting

The phone of the caller. This information is required if the service requests type is configured to automatically SMS messages customers upon changes of their service requests statuses

Tip

Available from CRM.COM R10.0.0

description

(optional)

StringA description of the service request

notes

(optional)

StringShared notes fir the service request

status_identifier

(mandatory)

Service Request Status Identifier

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

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

category_identifier

(mandatory)

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

(mandatory)

String

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

URGENCY1, URGENCY2, URGENCY3, CUSTOM1, CUSTOM2 , CUSTOM3, CUSTOM4, CUSTOM5

impact_level

(mandatory)

String

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

IMPACT1, IMPACT2, IMPACT3, CUSTOM1, CUSTOM2 , CUSTOM3, CUSTOM4, CUSTOM5

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

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
(semi-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
(semi-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. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

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

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

related_service_requests_set

(optional)

Set of Related Service Request ObjectsA list with the service requests that the raised service request relates to

...

Include Page
V4:related_service_requests_parameters
V4:related_service_requests_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "type_identifier" : { "name" : "PK_ServiceRequestTypes" },
    "accounts_receivable_identifier" : { "name" : "ACR0000000164 Polina Kestora"},
    "description" : "Web API Call - Create",
    "caller_email" : "p_kestora@crm.com",
    "caller_phone" : "99112233",
    "status_identifier" : { "name" : "Open" },
    "category_identifier" : { "name" : "Information" },
    "urgency_level" : "URGENCY1",
    "impact_level" : "IMPACT1",
    "owned_by_group_identifier" : { "name" : "Main Group"},
    "start_date" : "2016-07-18T11:00:00",
    "estimated_completion_time" :
        {
            "time_period_value"   : 6,
            "time_period_uot" : "DAYS"
        },
    "assigned_to" :
        {
            "user_identifier" : { "username" : "mpadministrator"}
        },
    "services_set" :
        [
            { "product_identifier" : { "code" : "Antenna" } }
        ]
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "actual_completion_date": null,
    "services_set": [],
    "response": {
      "responded_by": null,
      "description": null,
      "response_date": null,
      "category": null,
      "accepted_by": null
    },
    "notes": null,
    "related_service_requests_set": [],
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "SR00000288",
    "udf_float_4": null,
    "caller": {
      "last_name": "Kestora",
      "middle_name": null,
      "life_cycle_state": "FINANCIAL",
      "company_profile": null,
      "title": null,
      "first_name": "Polina",
      "type": "PERSON",
      "id": "F038161F36C845B98CEE7361A8C92157",
      "name": "Polina Kestora",
      "company_name": null,
      "demographics": {
        "gender": "FEMALE",
        "passport_issued_by_country": null,
        "social_security_number": null,
        "passport_number": null,
        "industry_sector": null,
        "name_day": {
          "month": null,
          "day": null
        },
        "date_of_birth": {
          "month": 3,
          "day": 4,
          "year": 1988
        },
        "id_number": "112233",
        "industry": null,
        "id_issued_by_country": null
      }
    },
    "udf_string_1": null,
    "impact_level": "IMPACT1",
    "assigned_to": {
      "unit": {
        "community_name": "Community",
        "id": "1",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "admin unit",
        "alternative_code": "adminunit"
      },
      "user": {
        "person_name": "CRM COM",
        "username": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com"
      }
    },
    "udf_string_2": null,
    "privacy_level": {
      "number": "1",
      "hierarchy_level": 1,
      "id": "E055FF075E4A4072BD09AF1091AA1CC3",
      "name": "Station"
    },
    "estimated_completion_time": {
      "time_period_value": 6,
      "time_period_uot": "DAYS"
    },
    "udf_string_3": null,
    "urgency_level": "URGENCY1",
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_6": null,
    "physical_goods_set": [],
    "udf_string_7": null,
    "udf_string_8": null,
    "final_resolution": {
      "finally_resolved_by": null,
      "final_resolution_date": null,
      "description": null,
      "category": null,
      "accepted_by": null
    },
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Kestora",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Polina",
        "type": "PERSON",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "name": "Polina Kestora",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": 3,
            "day": 4,
            "year": 1988
          },
          "id_number": "112233",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000164",
      "id": "C6CBAC948E53498F83FF52E6CD8B7221",
      "name": "ACR0000000164 Polina Kestora"
    },
    "temporary_resolution": {
      "temporary_resolution_date": null,
      "description": null,
      "temporarily_resolved_by": null,
      "category": null,
      "accepted_by": null
    },
    "id": "608DD058718747BC87B026CD825A53AE",
    "caller_email": "p_kestora@crm.com",
    "udf_date_1": null,
    "priority_level": 1,
    "udf_date_2": null,
    "referring_to": {
      "job": null,
      "subscription": null
    },
    "udf_date_3": null,
    "expected_completion_date": "2016-07-24T11:00:00",
    "udf_date_4": null,
    "start_date": "2016-07-18T11:00:00",
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "time_to_completion": {
      "time_period_value": 6,
      "time_period_uot": "DAYS"
    },
    "log_information": {
      "updated_date": "2016-07-18T08:05:36",
      "created_date": "2016-07-18T08:05:34",
      "created_by_unit": {
        "community_name": "Community",
        "id": "1",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "admin unit",
        "alternative_code": "adminunit"
      },
      "updated_by_unit": {
        "community_name": "Community",
        "id": "1",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "admin unit",
        "alternative_code": "adminunit"
      },
      "created_by_user": {
        "person_name": "CRM COM",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "CRM COM",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "owned_by_group": {
      "community_name": "Community",
      "id": "1",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG"
    },
    "status": {
      "life_cycle_state": "PENDING",
      "id": "SRStatus1",
      "name": "Open",
      "description": "To be approved",
      "alternative_code": "0"
    },
    "life_cycle_state": "PENDING",
    "type": {
      "id": "37595D6B05FF4D909385867F55E6235A",
      "name": "PK_ServiceRequestTypes",
      "description": null,
      "alternative_code": "P"
    },
    "caller_phone": "99112233",
    "category": {
      "classification": "INFORMATION",
      "id": "B4EA5CF943D747279A6094B5D044E0C8",
      "name": "Information",
      "description": null,
      "code": "INF"
    }
  }
}
 

...

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)

StringShared notes fir 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 , CUSTOM3, CUSTOM4, CUSTOM5

impact_level

(optional)

String

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

IMPACT1, IMPACT2, IMPACT3, CUSTOM1, CUSTOM2 , CUSTOM3, CUSTOM4, CUSTOM5

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

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

...

Include Page
V4:related_service_requests_update_parameters
V4:related_service_requests_update_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_complete
V4:service_request_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
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
themeConfluence
languagejavascript
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
           }
       }
} 

...

This method is updating a service request's response information and sets the service request to life cycle state "Responded". A single service request can be responded by each call.

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

status_identifier

(mandatory)

Service Request Status Identifier

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

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

response

(mandatory)

Service Request Response ObjectThe response that will be provided for the specified service request

...

Include Page
V4:service_request_response_parameters
V4:service_request_response_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000275" },
    "status_identifier" : {   "name" : "Responded" },
    "response" :
        {
            "category_identifier" : { "name" : "SR Resp. Category"},
            "responded_by_identifier" : { "username" : "mpadministrator"  },
            "response_date" : "2016-07-18T12:58:39",
            "description" : "Response Description"
        }
}  	

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Jobs",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Philippos",
        "type": "PERSON",
        "id": "39F2067A3A4A4AE886739E4643820B28",
        "name": "Philippos Jobs",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "2121",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000198",
      "id": "732CE3E9D1C44A9486284DDEFF4743FA",
      "name": "ACR0000000198 Philippos Jobs"
    },
    "life_cycle_state": "RESPONDED",
    "number": "SR00000275",
    "id": "CFD293E0B3E84ACE8C44673A6515EE4A",
    "description": null
  }
}

...

This method is updating a service request's temporary resolution information and sets the service request to life cycle state "Temporary Resolved". A single service request can be temporarily resolved by each call.

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

temporary_resolution

(mandatory)

Service Request Temporary Resolution ObjectThe temporary resolution that will be provided for the specified service request

...

Include Page
V4:service_request_temporary_resolution_parameters
V4:service_request_temporary_resolution_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000275" },
	"status_identifier" : {	"name" : "Temporary Resolved" },
	"temporary_resolution" :
        {
            "category_identifier" : { "name" : "Fixed"},
            "temporary_resolved_by_identifier" : { "username" : "mpadministrator"  },
            "temporary_resolution_date" : "2016-07-18T12:58:39",
            "description" : "Temporary Resolved Description"
        }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Jobs",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Philippos",
        "type": "PERSON",
        "id": "39F2067A3A4A4AE886739E4643820B28",
        "name": "Philippos Jobs",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "2121",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000198",
      "id": "732CE3E9D1C44A9486284DDEFF4743FA",
      "name": "ACR0000000198 Philippos Jobs"
    },
    "life_cycle_state": "TEMPORARY_RESOLVED",
    "number": "SR00000275",
    "id": "CFD293E0B3E84ACE8C44673A6515EE4A",
    "description": null
  }
}

...

This method is updating a service request's final resolution information and sets the service request to life cycle state "Final Resolved". A single service request can be finally resolved by each call.

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

status_identifier

(mandatory)

Service Request Status Identifier

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

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

final_resolution

(mandatory)

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

...

Include Page
V4:service_request_final_resolution_parameters
V4:service_request_final_resolution_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000275" },
	"status_identifier" : {	"name" : "Final Resolved" },
	"final_resolution" :
        {
            "category_identifier" : { "name" : "Fixed" },
            "final_resolved_by_identifier" : { "username" : "mpadministrator"  },
            "final_resolution_date" : "2016-07-18T12:58:39",
            "description" : "Resolution Description"
        }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Jobs",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Philippos",
        "type": "PERSON",
        "id": "39F2067A3A4A4AE886739E4643820B28",
        "name": "Philippos Jobs",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "2121",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000198",
      "id": "732CE3E9D1C44A9486284DDEFF4743FA",
      "name": "ACR0000000198 Philippos Jobs"
    },
    "life_cycle_state": "FINAL_RESOLVED",
    "number": "SR00000275",
    "id": "CFD293E0B3E84ACE8C44673A6515EE4A",
    "description": null
  }
}

...

This method is updating a service request by setting them as "Completed". A single service request can be completed by each call.

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

status_identifier

(mandatory)

Service Request Status Identifier

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

Include Page
V4:service_request_status_identifier
V4:service_request_status_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

 

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
	"status_identifier" : {	"name" : "Completed" },
    "service_request_identifier" : { "number" : "SR00000184" }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Papapavlou",
        "middle_name": "Loukia",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Miss",
        "first_name": "Loukia",
        "type": "PERSON",
        "id": "E12B1552198540D7BDBBE5CCF23D0EE5",
        "name": "Loukia Papapavlou",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": "99999999",
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": 12,
            "day": 13
          },
          "date_of_birth": {
            "month": 1,
            "day": 28,
            "year": 1991
          },
          "id_number": "11225588",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000026",
      "id": "ED512ED25BFF413280FA1BEB85DA9B1F",
      "name": "ACR0000000026 Loukia Papapavlou"
    },
    "life_cycle_state": "COMPLETED",
    "number": "SR00000184",
    "id": "8B796C7C74D34637B1C89A18C36FDFB4",
    "description": "the request was resolved"
  }
}

POST service_requests/response_accept

Tip

Available from CRM.COM R9.0.0

This method is updating a service request by setting the response acceptance information, considering that the specified response category is configured to require customer acceptance. A single service request can be accepted by each call

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

accepted_by_identifier

(mandatory)

Contact Information Identifier

The contact information that accepted the response on behalf of the customer. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

...

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000267" },
    "accepted_by_identifier" : { "id_number" : "112233"  }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Kestora",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Polina",
        "type": "PERSON",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "name": "Polina Kestora",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": 3,
            "day": 4,
            "year": 1988
          },
          "id_number": "112233",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000164",
      "id": "C6CBAC948E53498F83FF52E6CD8B7221",
      "name": "ACR0000000164 Polina Kestora"
    },
    "life_cycle_state": "RESPONDED",
    "number": "SR00000267",
    "id": "4FA45C6ABC49406F8FF1EFAE67EC1444",
    "description": null
  }
}

...

This method is updating a service request by setting the temporary resolution acceptance information. A single service request can be accepted by each call

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

description

(optional)

StringA description of the service request that will be updated

accepted_by_identifier

(mandatory)

Contact Information Identifier

The contact information that accepted the temporary resolution on behalf of the customer. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

...

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000264" },
    "accepted_by_identifier" : { "id_number" : "112233"  }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Kestora",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Polina",
        "type": "PERSON",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "name": "Polina Kestora",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": 3,
            "day": 4,
            "year": 1988
          },
          "id_number": "112233",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000164",
      "id": "C6CBAC948E53498F83FF52E6CD8B7221",
      "name": "ACR0000000164 Polina Kestora"
    },
    "life_cycle_state": "TEMPORARY_RESOLVED",
    "number": "SR00000264",
    "id": "BE4C41869EA340D9AEF303F9EF8A854C",
    "description": null
  }
}

...

This method is updating a service request by setting the temporary resolution acceptance information. A single service request can be accepted by each call

Resource URL

Parameters

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 that should be updated. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

description

(optional)

StringA description of the service request that will be updated

notes

(optional)

StringShared notes fir the service request

accepted_by_identifier

(optional)

Contact Information Identifier

The contact information that accepted the final resolution on behalf of the customer. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

...

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:service_request_short
V4:service_request_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000288" },
    "accepted_by_identifier" : { "id_number" : "112233"  }
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
  {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Kestora",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Polina",
        "type": "PERSON",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "name": "Polina Kestora",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": 3,
            "day": 4,
            "year": 1988
          },
          "id_number": "112233",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000164",
      "id": "C6CBAC948E53498F83FF52E6CD8B7221",
      "name": "ACR0000000164 Polina Kestora"
    },
    "life_cycle_state": "FINAL_RESOLVED",
    "number": "SR00000288",
    "id": "608DD058718747BC87B026CD825A53AE",
    "description": "Web API Call - Create"
  }
}