Tip |
---|
Table of Contents | ||
---|---|---|
|
...
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:
| ||||||
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 |
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 |
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 in Pending life cycle state. 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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
period (mandatory) | Number | The length of time for which a service request is close to estimated completion | ||||||
uot | String | The 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:
| ||||||
type_identifier | 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:
| ||||||
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 | ||||
---|---|---|---|---|
|
Examples
Expand | ||
---|---|---|
| ||
HTTP Method: GET
Request: Response:
|
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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_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.
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 |
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 |
...
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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_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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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:
| ||||||
type_identifier | 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:
| ||||||
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:
| ||||||
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:
| ||||||
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 | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
...
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:
| ||||||
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:
| ||||||
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:
| ||||||
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
| ||||||
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
| ||||||
description (optional) | String | A description of the service request | ||||||
notes (optional) | String | Shared 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:
| ||||||
category_identifier (mandatory) | Service Request Category Identifier | The category of the service request. The allowed service request category identifier fields are the following:
| ||||||
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 | 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:
| ||||||
privacy_level_identifier | The identifier of the privacy level | The privacy level of the service request. The allowed privacy level identifier fields are the following:
| ||||||
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 | Date | The date that the activity is created | ||||||
expected_completion_date | Date | The 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 Object | The 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 object | The assignment information for the service request. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules. | ||||||
(optional) | Service Request Referring To Object | The entities that the service request is referring to which can be a subscription or a job | ||||||
(optional) | Service Request Response Object | The response that will be provided to the service request | ||||||
(optional) | Service Request Temporary Resolution Object | The temporary resolution that will be provided to the service request | ||||||
(optional) | Service Request Final Resolution Object | The final resolution that will be provided to the service request | ||||||
(optional) | Set of Service Request Services Objects | A list of services for which the service request was raised for | ||||||
(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 | ||||||
(optional) | Set of Related Service Request Objects | A list with the service requests that the raised service request relates to | ||||||
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 |
Anchorservice_request_create referred objects parameters service_request_create referred objects parameters
Referred Parameter Objects Data
service_request_create referred objects parameters | |
service_request_create referred objects 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:
| ||||||
caller_email (optional) | Sting | The email of the caller. | ||||||
caller_phone (optional) | Sting | The phone of the caller.
| ||||||
description (optional) | String | A description of the service request | ||||||
notes (optional) | String | Shared 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:
| ||||||
category_identifier (optional) | Service Request Category Identifier | The category of the service request. The allowed service request category identifier fields are the following:
| ||||||
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 | 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:
| ||||||
privacy_level_identifier | The identifier of the privacy level | The privacy level of the service request. The allowed privacy level identifier fields are the following:
| ||||||
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 | Date | The date that the activity is created | ||||||
expected_completion_date | Date | The 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 Object | The 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 object | The assignment information for the service request | ||||||
(optional) | Service Request Referring To Object | The entities that the service request is referring to which can be a subscription or a job | ||||||
(optional) | Service Request Response Object | The response that will be provided to the service request | ||||||
(optional) | Service Request Temporary Resolution Object | The temporary resolution that will be provided to the service request | ||||||
(optional) | Service Request Final Resolution Object | The final resolution that will be provided to the service request | ||||||
(optional) | Set of Service Request Services Objects | A list of services for which the service request was raised for
| ||||||
(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
| ||||||
(optional) | Set of Related Service Request Objects | A list with the service requests that the raised service request relates to
|
...
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:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared 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:
| ||||||
(mandatory) | Service Request Response Object | The response that will be provided for the specified service request |
...
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:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared notes fir the service request | ||||||
(mandatory) | Service Request Temporary Resolution Object | The temporary resolution that will be provided for the specified service request |
...
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:
| ||||||
status_identifier (mandatory) | Service Request Status Identifier | The status of the service request. The allowed service request status identifier fields are the following:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared notes fir the service request | ||||||
(mandatory) | Service Request Final Resolution Object | The final resolution that will be provided for the specified service request |
...
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:
| ||||||
status_identifier (mandatory) | Service Request Status Identifier | The status of the service request. The allowed service request status identifier fields are the following:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared notes fir the service request |
...
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
...
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:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared 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:
|
...
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:
| ||||||
description (optional) | String | A 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:
|
...
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:
| ||||||
description (optional) | String | A description of the service request that will be updated | ||||||
notes (optional) | String | Shared 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:
|
...