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:
| |||||||||||||||||||||
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 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 Available from CRM.COM R10.0.0 | |||||||||||||||||||||
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 For releases prior CRM.COM R14.0.0, the following urgency levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well | |||||||||||||||||||||
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 For releases prior CRM.COM R14.0.0, the following impact levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well | |||||||||||||||||||||
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 (mandatory on conditions) | 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 From CRM.COM R14.0.0, this parameter is deprecated | |||||||||||||||||||||
(optional) | Service Request Temporary Resolution Object | The temporary resolution that will be provided to the service request From CRM.COM R14.0.0, this parameter is deprecated | |||||||||||||||||||||
(optional) | Service Request Final Resolution Object | The final resolution that will be provided to the service request From CRM.COM R14.0.0, this parameter is deprecated | |||||||||||||||||||||
(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 |
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request |
number | String | The number of the retrieved service request |
| description | String | The description of the retrieved service request |
life_cycle_state | String | The life cycle state of the retrieved service request which can be PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED |
| caller_email | String | The email address of the caller as specified on the retrieved service request |
| caller_phone | String | The phone number of the caller as specified on the retrieved service request Available from CRM.COM R10.0.0 |
| urgency_level | String | The urgency level of the retrieved service request, which can be one of the following: URGENCY1, URGENCY2, URGENCY3, CUSTOM1, CUSTOM2 , CUSTOM3, CUSTOM4, CUSTOM5 For releases prior CRM.COM R14.0.0, the urgency levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well |
| impact_level | String | The impact level of the retrieved service request, which can be one of the following: IMPACT1, IMPACT2, IMPACT3, CUSTOM1, CUSTOM2 For releases prior CRM.COM R14.0.0, the impact levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well |
| priority_level | Number | The priority level of the retrieved service request, which can be one of the following: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 |
| start_date | Date | The date that the service request is created |
| expected_completion_date | Date | The date that the service request is expected to be completed |
| actual_completed_date | Date | The date that the service request is actually completed |
| cancellation_reason | Service Requests Cancellation Object | The reason that the job was cancelled. This is applicable only if the job is on a cancelled life cycle state Available from CRM.COM R15 |
| notes | String | The shared notes of the retrieved service request |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Accounts Receivable object | The accounts receivable related with the specified service request | |
| caller | Contact Information object | The caller related with the specified service request |
| assigned_to | Assign Object | The assignment information of the retrieved service request |
| type | Service Request type object | The type information of the retrieved service request |
| status | Service Request Status object | The status information of the retrieved service request |
| category | Service Request Category object | The category of the retrieved service request |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the service request, measured in minutes, hours, days, weeks, years |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
| owned_by_group | Group object | The group that is owning the service request Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the service request Available from CRM.COM R18.0.0 |
| privacy_level | Privacy level object | The privacy level of the service request Deprecated from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved service request | |
| referring_to | Service Request Referring to Object | The entities for which the service request was raised for and can be a Subscription or a Job |
| response | Service Request Response Object | The response of the retrieved service request |
| temporary_resolution | Service Request Temporary Resolution Object | The temporary resolution of the retrieved service request |
| final_resolution | Service Request Final Resolution | The final resolution of the retrieved service request |
| services_set | Set of Services Objects | A list of services for which the service request was raised for |
| physical_goods_set | Set of Physical Goods Objects | A list of the physical goods for which the retrieved service request was raised for, which can be traceable or not traceable |
| related_service_requests_set | Set of Related Service Requests Objects | A list with the service requests for which the retrieved service request relates to |
| related_activities_set | Set of Related Activities Objects | A list with the activities for which the retrieved service request relates to Available from CRM.COM R14.0.0 |
| related_jobs_set | Set of Related Jobs Objects | A list with the jobs for which the retrieved service request relates to Available from CRM.COM R14.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"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:
{
"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"
}
}
}