Tip |
---|
Table of Contents | ||
---|---|---|
|
GET service_requests/show
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
...
(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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET service_requests/list
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
...
(semi-optional)
...
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
(semi-optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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 at least one of the semi-optional parameters.
Response Data
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET service_requests/get_overdue
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
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
...
uot
(mandatory)
...
MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
...
(optional)
...
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
(optional)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | ||
---|---|---|
| ||
HTTP Method: GET
Request: Response:
|
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET service_requests/get_temporary_resolved
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET service_requests/get_temporary_resolved_pending_acceptance
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
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
...
(optional)
...
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
(optional)
...
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)
...
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)
...
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:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
Tip |
---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
Tip |
---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST service_requests/create
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)
...
The type of the service request. The allowed service request type identifier fields are the following:
...
accounts_receivable_identifier
(mandatory)
...
The accounts receivable that will be related with the service request. The allowed accounts receivable identifier fields are the following:
...
contact_information_identifier
(optional)
...
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)
...
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)
...
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)
...
notes
(optional)
...
status_identifier
(mandatory)
...
The status of the service request. The allowed service request status identifier fields are the following:
...
category_identifier
(mandatory)
...
The category of the service request. The allowed service request category identifier fields are the following:
...
urgency_level
(mandatory)
...
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)
...
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 owned by group information of the service request. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the service request. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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)
...
expected_completion_date
(semi-optional)
...
(optional)
...
...
(optional)
...
Service Request Temporary Resolution Object
...
(optional)
...
(optional)
...
A list of services for which the service request was raised for
...
(optional)
...
A list of the physical goods for which the service request was raised for, which can be traceable or not traceable
...
(optional)
...
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
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/update
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)
...
The service request that should be updated. The allowed service request identifier fields are the following:
...
caller_email
(optional)
...
caller_phone
(optional)
...
The phone of the caller.
Tip |
---|
Available from CRM.COM R10.0.0 |
...
description
(optional)
...
notes
(optional)
...
status_identifier
(mandatory on conditions)
...
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)
...
The category of the service request. The allowed service request category identifier fields are the following:
...
urgency_level
(optional)
...
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)
...
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 owned by group information of the service request. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the service request. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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)
...
expected_completion_date
(optional)
...
(optional)
...
...
(optional)
...
Service Request Temporary Resolution Object
...
(optional)
...
(optional)
...
A list of services for which the service request was raised for
...
(optional)
...
A list of the physical goods for which the service request was raised for, which can be traceable or not traceable
...
(optional)
...
A list with the service requests that the raised service request relates to
...
fields_set
(optional)
...
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
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/respond
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
...
(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)
...
notes
(optional)
...
status_identifier
(mandatory)
...
The status of the service request. The allowed service request status identifier fields are the following:
...
(mandatory)
...
fields_set
(optional)
...
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
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/temporary_resolve
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
...
(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)
...
notes
(optional)
...
(mandatory)
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/final_resolve
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
...
(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)
...
The status of the service request. The allowed service request status identifier fields are the following:
...
description
(optional)
...
notes
(optional)
...
(mandatory)
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/complete
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
...
(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)
...
The status of the service request. The allowed service request status identifier fields are the following:
...
description
(optional)
...
notes
(optional)
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
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
...
(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)
...
notes
(optional)
...
accepted_by_identifier
(mandatory)
...
The contact information that accepted the response on behalf of the customer. The allowed contact information identifier fields are the following:
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/temporary_accept
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
...
(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)
...
accepted_by_identifier
(mandatory)
...
The contact information that accepted the temporary resolution on behalf of the customer. The allowed contact information identifier fields are the following:
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST service_requests/final_accept
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
...
(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)
...
notes
(optional)
...
accepted_by_identifier
(optional)
...
The contact information that accepted the final resolution on behalf of the customer. The allowed contact information identifier fields are the following:
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||
---|---|---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"token" : "{{token}}",
"service_request_identifier" : { "number" : "SR00000288" },
"accepted_by_identifier" : { "id_number" : "112233" }
} |
Response:
theme | Confluence |
---|---|
language | javascript |
linenumbers | true |
name | blue |
---|
Child pages (Children Display) | ||
---|---|---|
|