Table of Contents | ||||
---|---|---|---|---|
|
...
Controlling Results Count
By default, 20 , items will be returned at a time. However, you can retrieve up to 50 items in a single API call by changing the ‘limit’ field. If you wish to retrieve more than 50 listings, you can do so by using the 'page' field and making more than one API call.
...
Parameter | Default | Description |
---|---|---|
limit | 20 | Number The number of listings to show. Maximum is 50. |
page | 1 | Page number to show. To view more than 50 listings, make successive API calls while incrementing this field. |
...
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,
...
the "recid" or "service_id_fmt" is
...
Required.
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/services.json |
...
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 |
---|---|
type | REMARKS |
service_recid | 1 |
remarks | Test Remark |
Results
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
recid | no | Integer | *Conditionally Requiredif attempting to UPDATE a Service Charge | ||
service_recid | yes | Integer | The RECID of the Service that the charge is for | ||
charge_recid | yes | Integer | RECID of the applicable charge catalog. | ||
description | no | String | The details or description of the charge on the Equipment | ||
amount | no* | Decimal | The amount to be charged. *Required if charge does not have an amount on it. | ||
quantity | no | Integer | 1 | The quantity of charge to be used. | |
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated |
gla | no | Integer | Recid of GLA to assign to Service Charge | ||
location | no | Integer | Location that this Charge applies to for the service | ||
bill_date | no | String | The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results. | ||
stop_date | no | String | The Date the Recurring Charge should stop on. YYYY-MM-DD format. Other formats may give unexpected results. | ||
effective | no | String | today, backdate | today | Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date. |
...
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 |
---|
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | The RECID of the Service that the GLA is for | ||
gla | yes | String | Record ID(s) of the applicable GLA(s). | ||
gla_percent | yes | String | Percentages to apply to each GLA. All percentages must equal exactly 100. | ||
gla_type | yes | String | The type(s) of GLA(s). |
Call:
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | The RECID of the Service that the Contact is for | ||
contact | yes | String | Record ID(s) of the contact(s). |
...
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 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | Recid of Service | ||
location | yes | Integer | Recid(s) of the Location(s) to assign to the Service. | ||
report_911 | yes | Integer | 1 = yes; 0 = no | Designate if Location should show on emergency 911 feed | |
location_status | yes | Integer | 1 = yes; 0 = no | Status of Location |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
location | 1 |
report_911 | 1 |
location_status | 1 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | Recid of Service | ||
equipment | yes | String | Recid(s) of Equipment to assign to the Service |
...
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 |
---|
...