Table of Contents | ||||
---|---|---|---|---|
|
...
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
|
*Extra Parameters can be appended to the URL in standard Query String fashion.
Write Call
Insert excerpt SQL API Calls SQL API Calls nopanel true
Available Fields
Field | Required | Data Type | Options | Default | Notes | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recid | no* | Integer | Identifier of the record. *See Note Below | ||||||||||
status | yes | Integer38470084 | The status of the service. | ||||||||||
serv_catalog | yes | Integer38470084 | 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. The service_id field can be formatted or unformatted. The service_id cannot be updated. *See Note Below. | ||||||||||
owner | no* | Integer38470084 | Record ID of either the Contact or the Department owner. | ||||||||||
owner_type | no* | String | "contact" or "department" | Type of owner | |||||||||
location | no | Integer38470084 | Recid of location for service. | ||||||||||
service_host | no | Integer38470084 | Recid of Service Host for service. | ||||||||||
sla | no | Integer38470084 | 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 | Integer38470084 | 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 | Integer38470084 | Recid of Associated Service. | ||||||||||
equipment | no | String38470084 | Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875. | ||||||||||
contact | no | String38470084 | 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 | String38470084 | 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 | Integer38470084 | 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* | String38470084 | List Value(s) of Expense Type(s). *Required if GLA is specified. | ||||||||||
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 | Integer38470084 | IF service_type = "data" OR "backbone". Recid of bandwidth record. | ||||||||||
auth_code_type | no | Integer38470084 | IF service_type = "authcode". Recid of authcode type. | ||||||||||
service_class | no | Integer38470084 | IF service_type = "authcode". Recid of Service Class for authcode. | ||||||||||
rating_group | no | Integer38470084 | .Services API Calls v2020.4 | 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" is Required. If both are passed they must match the same record.
...
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 |
directory | 1 |
report_911 | 1 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | RECID of service. RECID column from SERVICES table. | ||
pools | yes | String | One or more RECIDs of Pools. If multiple, separate with commas. Example: 23,43 |
...
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 |
---|
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | RECID of service. RECID column from SERVICES table. | ||
remarks | yes | String | The remark to add to the service |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | REMARKS |
service_recid | 1 |
remarks | Test Remark |
Results
...
Below is the proper format for making a separate request.
...
.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CHARGES&field1=value1 ... |
...
Field | Required | Data Type | Options | Default | Notes | ||
---|---|---|---|---|---|---|---|
recid | no | Integer | *Conditionally Requiredif attempting to UPDATE a Service Charge RECID for charges reads as "SERV1234" but when using that RECID for the API you only need the numbers, so "1234" from the example. | ||||
service_recid | yes | Integer | The RECID of the Service that the charge is for. | Integer | RECID column from SERVICES table. | ||
charge_recid | yes | Integer | RECID of the applicable charge catalog. RECID column from CHRG_CATALOG table. | ||||
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. | ||||
type | yes | String | CHARGES | ||||
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 | Integer38470084 | RECID of GLA to assign to Service Charge | ||||
location | no | Integer38470084 | Location that this Charge applies to for the service | ||||
start_date | no | String | MRC ARC | The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges. | |||
stop_date | no | String | MRC ARC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges | |||
recurring_date | no | String | ARC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Alternate Recurring Charges | |||
transaction_date | no | String | NRC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Non-Recurring Charges | |||
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. RECID column from SERVICES table. | ||
gla | yes | String38470084 | 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 | String38470084 | 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. RECID column from SERVICES table. | ||
contact | yes | String38470084 | 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 |
---|
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | Yes | Integer | The RECID of the Service that the UDF is for. RECID column from SERVICES table. | ||
udf_UDF-RECID | Yes* | Integer | UDF-RECID is the RECID of the UDF to assign the value to. RECID column from USER_DEFINED_FIELDS_VALS table. Example: udf_684=value
| ||
udf_UDF-IDENTIFIER | Yes* | Mixed | IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value
|
...
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. RECID column from SERVICES table. | ||
location | yes | Integer38470084 | 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. RECID column from SERVICES table. | ||
equipment | yes | String38470084 | 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 |
---|
...