Table of Contents | ||||
---|---|---|---|---|
|
...
Parameter | Default | Description |
---|---|---|
LIMIT | 20 | Number of listings to show. |
PAGE | 1 | Page number to show. To view more than 50 listings, make successive API calls while incrementing this field. |
Response Data
Name | Datatype | Searchable | Notes |
---|---|---|---|
BILLABLE | Yes/No | Yes | To indicate whether the service item is or is not billable |
STATUS_DATE | string | Yes | Shows the date when the service was set to its current status |
SERVICE_HOST | string | Yes | The Service Host associated with the service |
SERVICE_ID | string | Yes | Service Id (phone_number, etc.) |
SERVICE_ID_FMT | string | Yes | Formatted Service Id |
CATALOG | string | Yes | Service Catalog name |
OWNER | string | Yes | Name of the service owner – either a person or org hierarchy |
LOCATIONS_PATH | string | Yes | The hierarchical path to the location of the service; use LOCATIONS when searching |
SLA_CATALOG_PATH | string | Yes | The hierarchical path to the SLA of the service; use SLA when searching |
SERVICES_STATUS | string | Yes | The current status of the service |
SERVICES_UDF | list | No | List of all the User Defined Fields and the selected values for this service |
SERVICES_CHARGES | list | No | Charges listed for this service |
SERVICES_CONTACTS | list | No | Contacts associated with the service |
SERVICES_EQUIPMENT | list | No | Pieces of equipment to be used/listed for this service |
SERVICES_EXPENSE_GLA | list | No | Expense G/L Accounts to be used for billing of this service |
SERVICES_REMARKS | list | No | List of all remarks/comments for this service |
...
Type | Description | Extra Parameters* | Searchable | Results | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CONTACTS | Retrieve available Contacts | CTYPE - Type of contact. Example: "worker" | yes | Contacts Results
| |||||||||||
DEPTHIER | Retrieve available Department Hierarchies | Coming Soon | Department Hierarchy Results
| ||||||||||||
EXPENSE_TYPE | Retrieve available Expense Types | no | Expense Types Results
| ||||||||||||
GLAS | Retrieve available GLAs | no | GLAs Results
| ||||||||||||
LOCATIONS | Retrieve available Locations | yes | Locations Results
| ||||||||||||
CHARGE_CATALOG | Retrieve available Charge Catalogs | yes | Charge Catalog Results
| ||||||||||||
SERVICE_CATALOG | Retrieve available Service Catalogs | yes | Service Catalog Results
| ||||||||||||
SERVICE_HOSTS | Retrieve available Service Hosts | no | Service Hosts Results
| ||||||||||||
UDFS | Retrieve available User Defined Fields (UDF) | SERV_CATALOG_RECID (required) | no | UDFs Results
| |||||||||||
SLAS | Retrieve available SLAs | no | SLAs Results
| ||||||||||||
POOLS | Retrieve available Service Pools | no | Service Pools Results
| ||||||||||||
SERVICE_CLASSES | Retrieve available Service Classes | no | Service Classes Results
| ||||||||||||
SERVICE_HOST_PARTITIONS | Retrieve available Service Host Partitions | no | Service Host Partitions Results
| ||||||||||||
AUTH_CODE_TYPE | Retrieve available Auth Code Types | no | Auth Code Types Results
| ||||||||||||
BANDWIDTH | Retrieve available Bandwidths | no | Bandwidth Results
| ||||||||||||
RATING_GROUP | Retrieve available Rating Groups | no | Rating Groups Results
| ||||||||||||
SERVICE_STATUS | Retrieve available Service Statuses | no | Service Status Results
|
...
Field | Required | Data Type | Options | Default | Notes | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recid | no* | Integer | Identifier of the record. *See Note Below | ||||||||||
status | yes | Integer | The status of the service. | ||||||||||
serv_catalog | yes | Integer | Recid of the Service Catalog item.
| ||||||||||
service_id | yes | String | Service ID of this service. Before inserting a new record, the system confirms there is no existing matching formatted version. If a match is found, the call will update the appropriate record. | ||||||||||
service_id_fmt | no* | String | Formatted version of the Service ID. *See Note Below | ||||||||||
owner | no* | Integer | Record ID of either the Contact or the Department owner. | ||||||||||
owner_type | no* | String | "contact" or "department" | Type of owner | |||||||||
location | no | Integer | Recid of location for service. | ||||||||||
service_host | no | Integer | Recid of Service Host for service. | ||||||||||
sla | no | Integer | Recid of SLA for service. | ||||||||||
reference | no | String | Reference for service | ||||||||||
billable | no | Integer | 1 = yes; 0 = no | Designate if the Service is Billable | |||||||||
billing_group | no | Integer | Recid of billing group for service. | ||||||||||
essential | no | Integer | 1 = yes; 0 = no | Designate if this is an essential Service. | |||||||||
status_date | yes | String | Date status was set for Service. Format “YYYY/MM/DD”. | ||||||||||
assoc_service | no | Integer | Recid of Associated Service. | ||||||||||
equipment | no | String | Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875. | ||||||||||
contact | no | String | Recid(s) of Contacts to add to Service. If multiple contacts are to be assigned, separate recids with commas. Example: 1234,7894. | ||||||||||
remarks | no | String | Remarks to add to the Service. | ||||||||||
pool | no | String | Recids of Service pool(s) to add to the Service. If multiple contacts are to be assigned, separate recids with commas. Example: 548,785. | ||||||||||
gla | no | Integer | Recid(s) of GLA record(s) to assign to this service. If multiple GLAs are to be assigned, separate recids with commas. Example: 874,32. | ||||||||||
gla_percent | no* | String | 100 | Percentage(s) of this Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100. | |||||||||
gla_type | no* | String | List Value(s) of Expense Type(s). *Required if GLA is specified. | ||||||||||
service_type | yes | String | "phone", "data", "authcode", "backbone" | Type of Service. This value determines specific fields and requirements listed below. | |||||||||
directory | yes | Integer | 1 = yes; 0 = no | IF service_type = "phone". Designates if this Service is to be listed in the directory. | |||||||||
report_911 | yes | Integer | 1 = yes; 0 = no | IF service_type = "phone". Designates if this Service is to be listed in emergency 911 feed. | |||||||||
multiple_locations | no | Integer | 1 = yes; 0 = no | IF service_type = "phone". Designates if this Service has multiple locations. | |||||||||
bandwidth | no | Integer | IF service_type = "data" OR "backbone". Recid of bandwidth record. | ||||||||||
auth_code_type | no | Integer | IF service_type = "authcode". Recid of authcode type. | ||||||||||
service_class | no | Integer | IF service_type = "authcode". Recid of Service Class for authcode. | ||||||||||
rating_group | no | Integer | Services API Calls | Recid of Rating Group for the Service. Config USE_RATING_GROUP must be set to TRUE to use this field |
Note: When updating a record, either the "recid" or "service_id_fmt" is required.
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Available |
serv_catalog | 1 |
service_id | 5558675309 |
status_date | 2019/03/18 |
service_type | Phone |
directory | 1 |
report_911 | 1 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
pools | 1 |
Results
If the request is successful, the Recid(s) of the linking records will be returned in the same order as provided:
Toggle cloak |
---|
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
remarks | Test Remark |
Results
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
charge_recid | 1 |
Results
If the request is successful, the RECID of the new Service charge is returned as follows:
Toggle cloak |
---|
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
contact | 1 |
Results
If the request is successful, the RECID(s) of the new service contact records will be returned in the same order as provided:
Toggle cloak |
---|
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
udf_UDF-RECID1 | 1 |
udf_UDF-RECID2 | Test |
udf_UDF-RECID3 | 2019/12/31 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
location | 1 |
report_911 | 1 |
location_status | 1 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
equipment | 1 |
Results
If the request is successful, the Recid of the Service Equipment record(s) will be returned in the order provided:
Toggle cloak |
---|
...