Available from CRM.COM R9.0.0
GET service_requests/configuration/types/list
This method returns the service request types that are allowed to be used in the system as these are defined in active Service Request Definitions. Multiple service request types are returned by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be providing the service request type. The group is filtered against the service request types' allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be providing the service request type. The unit is filtered against the service request types' allowed organisational units. The allowed unit 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type |
name | String | The name of the retrieved service request type |
alternative_code | String | The alternative code of the retrieved service request type |
| description | String | A description of the retrieved service request type |
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 |
| estimated_completion_time | Time Period Object | The time that is estimated to be required in order complete service requests of this type, measured in minutes, hours, days, weeks, years |
| log_information | Log Information Object | The log information of the retrieved service request type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Test123",
"udf_string_1": null,
"udf_string_2": null,
"estimated_completion_time":
{
"time_period_value": 2,
"time_period_uot": "MONTHS"
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-05-26T13:19:25",
"created_date": "2015-05-18T12:43:59",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_8": null,
"id": "071C3C130B804FB593908CA4BBE1A276",
"description": null,
"alternative_code": "T_1"
},
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Information",
"udf_string_1": null,
"udf_string_2": null,
"estimated_completion_time":
{
"time_period_value": 2,
"time_period_uot": "HOURS"
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-10-07T11:11:33",
"created_date": "2015-01-09T15:57:22",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
"email": "e_michailidou@crm.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_8": null,
"id": "3E19C42A76820EFEF54DB4F103DC1BFC",
"description": null,
"alternative_code": "I"
},
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Request for Change",
"udf_string_1": null,
"udf_string_2": null,
"estimated_completion_time":
{
"time_period_value": 2,
"time_period_uot": "HOURS"
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-10-08T15:18:40",
"created_date": "2015-01-09T16:37:23",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
"email": "e_michailidou@crm.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_8": null,
"id": "C0014B5217E42FCF43100373A17E9A6E",
"description": null,
"alternative_code": "RFC"
},
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Technical",
"udf_string_1": null,
"udf_string_2": null,
"estimated_completion_time":
{
"time_period_value": null,
"time_period_uot": "SECONDS"
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-08-26T12:25:31",
"created_date": "2015-01-20T17:24:48",
"created_by_unit":
{
"community_name": "Internal Community",
"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":
{
"community_name": "Internal Community",
"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": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
"email": "e_michailidou@crm.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"udf_string_8": null,
"id": "C0F246EC670740F793868C1CA78D6AF6",
"description": null,
"alternative_code": "T"
}
]
}
GET service_requests/configuration/statuses/list
This method returns the statuses that are allowed to be used by service requests of specific type. Multiple statuses are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed service request type identifier fields are the following:
| ||||||||||||
life_cycle_state (optional) | Sting | The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are: PENDING, RESPONDED, TEMPORARY RESOLVED, FINAL RESOLVED and COMPLETED | ||||||||||||
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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type status |
| default | Boolean | Determines if the service request type status is the default status or not |
| status | Service Request Status Object | The actual status provided by the service request type status |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": true,
"status":
{
"life_cycle_state": "PENDING",
"id": "4174EEED1CBFD73A67AB75C5DF99AFED",
"name": "To Be Approved",
"description": "To be Approved - Pending",
"alternative_code": "TBA"
},
"id": "7244393FFDA6E09D16CACCA0A87D8772"
},
{
"default": false,
"status":
{
"life_cycle_state": "RESPONDED",
"id": "3719E9998E567A788A865CD1B4556821",
"name": "Assigned",
"description": "Assigned",
"alternative_code": "ASG"
},
"id": "6FB8BA4DD6658972FC5AD9D6C74D9A84"
},
{
"default": false,
"status":
{
"life_cycle_state": "RESPONDED",
"id": "C46FA997FD069D6F1863F4F6A02916C6",
"name": "In Progress",
"description": null,
"alternative_code": "IP"
},
"id": "8A79FE4BBDA349FC61E8875DE034FDEE"
},
{
"default": false,
"status":
{
"life_cycle_state": "TEMPORARY_RESOLVED",
"id": "0B7EF8D78A8711BA03FFF11EB0BBC0F6",
"name": "Temporary Solution",
"description": null,
"alternative_code": "TS"
},
"id": "BFF9AB00ADAF3A860FBDDDC0D30BA039"
},
{
"default": false,
"status":
{
"life_cycle_state": "FINAL_RESOLVED",
"id": "78BD681A48EE3EAE9246D25AB76F632B",
"name": "Final Solution",
"description": null,
"alternative_code": "FS"
},
"id": "0F0CCA77C5AF23955E2CF9277BE2D733"
},
{
"default": false,
"status":
{
"life_cycle_state": "COMPLETED",
"id": "5611E4C4BD556315E1AE9F9A883158D2",
"name": "Accepted by Customer",
"description": "The Service Request has been accepted by customer/caller ",
"alternative_code": "ACC"
},
"id": "FE655F50C6A9BFD9E847291B6E706785"
}
]
}
GET service_requests/configuration/categories/list
This method returns the service request categories that are allowed to be used by service requests of a specific type. Multiple service request categories are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the categories. The categories are filtered against the allowed categories of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type category |
| default | Boolean | Determines if the service request type category is the default category in the service request type or not |
| category | Service Request Category Object | The actual category provided by the service request type category |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": true,
"id": "5468158350D9469EB4467A7E2C9D089C",
"category":
{
"parent_id": "451E8F57CFCD9D425E599832F3AC32DE",
"id": "3B14EF18F2D75893416B62208A07EA51",
"name": "Normal",
"description": "Normal",
"code": "ADV_NML"
}
},
{
"default": false,
"id": "7B0B1EDEF35F4A548EE3BB3C1844A676",
"category":
{
"parent_id": "451E8F57CFCD9D425E599832F3AC32DE",
"id": "E99CB6E1D075857EB7DE9985782F577F",
"name": "Difficult",
"description": "Difficult",
"code": "ADV_DFCT"
}
},
{
"default": false,
"id": "BA2B74FB65B8450AB628EB1CB0AFA1B6",
"category":
{
"id": "451E8F57CFCD9D425E599832F3AC32DE",
"name": "Advice",
"description": "Advice Related",
"code": "ADV"
}
}
]
}
GET service_requests/configuration/response_categories/list
This method returns the service request response categories that are allowed to be used by service requests of a specific type. Multiple service request response categories are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the response categories. The response categories are filtered against the allowed response categories of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type response category |
| default | Boolean | Determines if the service request type response category is the default response category in the service request type or not |
| category | Service Request Response Category Object | The actual response category provided by the service request type category |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": false,
"id": "D70228FB4221FB96610BD3DA20BB7B65",
"category":
{
"parent_id": null,
"requires_customer_acceptance": true,
"id": "AB9574217CF96FE7FC5B2A134EF1ADC9",
"name": "Approved for Resolution",
"description": null,
"code": "AFR"
}
},
{
"default": true,
"id": "ED7F4F27E8FB43EEB3AC46E351AC1BBA",
"category":
{
"parent_id": "73BF512136DB35FE56A60ABF5DF5A91C",
"requires_customer_acceptance": false,
"id": "7FEF386893AB9744F82E497D72BEB76A",
"name": "Technical Agent",
"description": null,
"code": "TCA"
}
}
]
}
GET service_requests/configuration/temporary_resolution_categories/list
This method returns the service request temporary resolution categories that are allowed to be used by service requests of a specific type. Multiple service request temporary resolution categories are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the temporary resolution categories. The temporary resolution categories are filtered against the allowed temporary resolution categories of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type temporary resolution category |
| default | Boolean | Determines if the service request type temporary resolution category is the default temporary resolution category in the service request type or not |
| category | Service Request Temporary Resolution Category Object | The actual temporary resolution category provided by the service request type temporary resolution category |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": true,
"id": "1257FAFC51E521FAF3BFAB15C79CB09C",
"category":
{
"id": "6559C7CE07640154D674E1B5B802693C",
"name": "Technical Temporary Resolution",
"description": null,
"code": "TTR"
}
},
{
"default": false,
"id": "CBF5CF9BDC35677BF9933B0FB838C6F3",
"category":
{
"parent_id": "6559C7CE07640154D674E1B5B802693C",
"id": "31126D17295386308CEDEDB9A67D526D",
"name": "Workaround",
"description": "test",
"code": "WRD"
}
}
]
}
GET service_requests/configuration/final_resolution_categories/list
This method returns the service request final resolution categories that are allowed to be used by service requests of a specific type. Multiple service request final resolution categories are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the final resolution categories. The final resolution categories are filtered against the allowed final resolution categories of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type final resolution category |
| default | Boolean | Determines if the service request type final resolution category is the default final resolution category in the service request type or not |
| category | Service Request Final Resolution Category Object | The actual final resolution category provided by the service request type final resolution category |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": false,
"id": "15FFEE41D6E6AAC0B9F8D7327D6294B1",
"category":
{
"id": "D3E8465639CAA0DA093FB96230B9B400",
"name": "Technical Final Resolution",
"description": null,
"code": "TFR"
}
},
{
"default": true,
"id": "C2F591C9610382F3A37FAFBADE20B59E",
"category":
{
"parent_id": "D3E8465639CAA0DA093FB96230B9B400",
"id": "376C4D455CAA3F8F5A599A9F936EC738",
"name": "Custom Change",
"description": "test",
"code": "CC"
}
}
]
}
GET service_requests/configuration/physical_goods/list
This method returns the physical goods that are allowed to be used by service requests of specific type. Multiple physical goods are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the physical goods. The physical goods are filtered against the allowed physical goods of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type physical good |
Product Object | The actual product provided by the service request type physical good | |
| product_type | Product Type Object | The actual product type provided by the service request type physical good |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "0D06FBC11A4D8FF8F1102DB115F73207",
"product": null
},
{
"product_type": null,
"id": "869A69597600C9CE9564D1BB988C92DD",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
},
{
"product_type":
{
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"name": "TV Guide",
"id": "E147D48A6B94C942036314DF146C5E9A",
"description": "Channel Guide - Hard Copy",
"alternative_code": "TVG"
},
"id": "29F4FE24599946C999112884846577A4",
"product": null
},
{
"product_type":
{
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": true,
"classification": "PHYSICALGOODS",
"composition_method": "FIXEDBUNDLE",
"name": "NPG Bundle",
"id": "AD60CE70C4BF4B9BB323597B816DB878",
"description": null,
"alternative_code": "NB"
},
"id": "91769DD3549C43EC88542404471E81C2",
"product": null
},
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FIXEDBUNDLE",
"name": "TPG Bundle",
"id": "82DC9C7986C84E7A9B7F73BC5C144DA5",
"description": null,
"alternative_code": "TB"
},
"id": "C7510884F7224B98B8EE329D25EF9FEB",
"product": null
},
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FIXEDBUNDLE",
"name": "TPG Bundle 3",
"id": "900131A568ED49329AD016B651702032",
"description": null,
"alternative_code": "TB3"
},
"id": "9F6B9CFDB84D4758AF4FA9A1E49C33BE",
"product": null
}
]
}
GET service_requests/configuration/services/list
This method returns the services that are allowed to be used by service requests of specific type. Multiple services are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the services. The services are filtered against the allowed services of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type service |
Product Object | The actual product provided by the service request type service | |
| product_type | Product Type Object | The actual product type provided by the service request type service |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"product_type": null,
"id": "12073204AEAF56BB11E900D26C7CCAA8",
"product":
{
"product_type":
{
"service_type": "ONETIME",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"name": "One Time Services - Flat",
"description": "A type which is used for one time services",
"alternative_code": "OTS-F"
},
"id": "362AF22847BA4ED0CDED5CDFF8BABBC1",
"description": "Delivery of Materials Service Charge",
"code": "Material Delivery",
"alternative_code": "MD"
}
}
]
}
GET service_request/configuration/activity_types/list
This method returns the activity types that are allowed to be used by service requests of specific type. Multiple activity types are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the activity types. The activity types are filtered against the allowed activity types of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type activity type |
| activity_type | Activity Type Object | The actual activity type provided by the service request type activity type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"activity_type":
{
"id": "938B9B6411AAB03DC25B3F569A443C6D",
"name": "InstallationsX",
"description": "Test",
"alternative_code": "INX"
},
"id": "9DF16EEB39322907E9F2451CFAFD7D66"
},
{
"activity_type":
{
"id": "F609C9D1CD43463DA810B1EC415BB5E1",
"name": "Meeting",
"description": null,
"alternative_code": "M"
},
"id": "078E673E509943AD89517860874F6FF0"
},
{
"activity_type":
{
"id": "6DFD8FD0D5024AC48750368FC39D13A8",
"name": "Demonstration",
"description": null,
"alternative_code": "D"
},
"id": "BD1A074EFB544FB6B44C1BC4694C44D3"
}
]
}
GET service_requests/configuration/job_types/list
This method returns the job types that are allowed to be used by service requests of specific type. Multiple job types are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the job types. The job types are filtered against the allowed job types of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type job type |
| job_type | Activity Type Object | The actual job type provided by the service request type job type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"id": "76CF2BDE628D46469B542A27B186C0D7",
"job_type":
{
"fulfillment_method": "BASED_ON_DELIVERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"id": "DD56C4D55BACC20DED28F7EAB8F15BE9",
"name": "Installation Job",
"description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
"alternative_code": "001"
}
}
]
}
GET service_request/configuration/impact_levels/list
This method returns the impact levels that are allowed to be used by service requests of any type. Only impact levels defined in the active Service Request Definitions and set as Supported are retrieved. Multiple impact levels are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request impact level |
name | String | The name of the retrieved service request impact level |
label | String | The label of the retrieved service request impact level |
| default | Boolean | Determines if the service request impact level is the default impact level or not |
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": false,
"label": null,
"id": "32B386252FAE191391BF80FCB5BA5136",
"name": "CUSTOM5"
},
{
"default": true,
"label": "Impact 1",
"id": "59FDC883600EB919E7AACEA9FC4E7A77",
"name": "IMPACT1"
},
{
"default": false,
"label": null,
"id": "8B302C9A2BD3F10A1740A8441B926D35",
"name": "CUSTOM3"
},
{
"default": false,
"label": null,
"id": "A8D98094A2EE3C67981CE59DFD969813",
"name": "CUSTOM4"
},
{
"default": false,
"label": "Impact 4",
"id": "B32C9D1D6C190EDD0131293A9B6E7533",
"name": "CUSTOM1"
},
{
"default": false,
"label": null,
"id": "D40F007CE2B0171376877E15023DEF69",
"name": "CUSTOM2"
},
{
"default": false,
"label": "Impact 3",
"id": "EE684F41532B7E02500D54BCA23A3D58",
"name": "IMPACT3"
},
{
"default": false,
"label": "Impact 2",
"id": "FE7695D19A3A9E2CA499C71B5D4CB6E4",
"name": "IMPACT2"
}
]
}
GET service_request/configuration/urgency_levels/list
This method returns the urgency levels that are allowed to be used by service requests of any type. Only urgency levels defined in the active Service Request Definitions and set as Supported are retrieved. Multiple urgency levels are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request urgency level |
name | String | The name of the retrieved service request urgency level |
label | String | The label of the retrieved service request urgency level |
| default | Boolean | Determines if the service request urgency level is the default urgency level or not |
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": false,
"label": null,
"id": "0EE5F5701B8848817EE953CBC7EC27F3",
"name": "CUSTOM2"
},
{
"default": false,
"label": "Urgency 4",
"id": "32A2661FD56523075E1CE07773DE6671",
"name": "CUSTOM1"
},
{
"default": false,
"label": "Urgency 2",
"id": "346F770CF0E1951CADF1B1F8E49EAFAF",
"name": "URGENCY2"
},
{
"default": true,
"label": "Urgency 1",
"id": "8B02601AEA771293940D11F140D4B208",
"name": "URGENCY1"
},
{
"default": false,
"label": null,
"id": "C94369A2CFA07DDA0BC7535651218DE5",
"name": "CUSTOM4"
},
{
"default": false,
"label": "Urgency 3",
"id": "CDFE1239A4D77A4AA6826E86A3B1B03E",
"name": "URGENCY3"
},
{
"default": false,
"label": null,
"id": "D0BF1FDA667E5193BA6F4FA4356DBC9B",
"name": "CUSTOM3"
},
{
"default": false,
"label": null,
"id": "F8B8263FE0B896FEE7F1FA56C6C39BC7",
"name": "CUSTOM5"
}
]
}
GET service_requests/configuration/warranties/list
This method returns the warranties that cover physical goods in service requests of a specific type. Multiple warranties are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
service_request_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the service request that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved service request type warranty |
| warranty | Warranty Object | The Warranty that covers service requests of the specified type |
| response_category | Set of Service Request Response Categories | The Response Categories which determine when the warranty covers a physical good |
| final_resolution_category | Set of Service Request Final Resolution Categories | The Final resolution Categories which determine when the warranty covers a physical good |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response: