Table of Contents
Table of Contents | ||||
---|---|---|---|---|
|
Read Call
...
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
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
Insert excerpt SQL API Calls SQL API Calls nopanel true
Insert excerpt Custom API Custom API nopanel true
Available Fields
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. The service_id _fmt | no* | String | Formatted version of the Service IDfield can be formatted or unformatted. The service_id cannot be updated. *See Note Below. | |||||||
owner | no* | Integer | Record ID of either the Contact or the Department owner. The API will validate if the Owner's GLA Format is compatible with the Service's Billing Group Format. | ||||||||||
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. The Override GLA Format should match the Billing Group Format of the Service, | ||||||||||
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. If both are passed they must match the same record.
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 |
Results
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Pools
Services can be assigned to one or more Pools.
Below is the proper format for making a separate request.
Note: "type=POOLS" to indicate that this is to add a Service to one or more Pools.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=POOLS&field1=value1 ... |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | IntegerRecid of service | RECID column from SERVICES table. | ||
pools | yes | String | One or more Recids 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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Remarks
Remarks can be added to services.
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer |
RECID column from SERVICES table. | |||||
remarks | yes | String | The remark to add to the service |
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/services.json |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | REMARKS |
service_recid | 1 |
remarks | Test Remark |
Results
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Charges
Charges can be easily added to a Service. If multiple Charges need to be added to Service, then separate POST requests will need to be made.
Below is the proper format for making a separate request. Note "type=CHARGES" to indicate that this is to create a Service Charge record.
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 | IntegerThe | RECID of the Service that the charge is forRECID column from SERVICES table. | ||||
charge_recid | yesno* | Integer | RECID of the applicable charge catalog.column from CHRG_CATALOG table. *Conditionally Required if attempting to add a new Service Charge | ||||
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 Charge to be used. Only allowed if Charge Catalog allows it. | |||
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false | ||
gla | no | Integer | Recid RECID of GLA to assign to Service Charge | ||||
location | no | Integer | Location that this Charge applies to for the service | ||||
billstart_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 | StringThe Date the Recurring Charge should stop on. | MRC ARC | YYYY-MM-DD format. Other formats may give unexpected results. effectiveUsed for Monthly Recurring Charges and Alternate Recurring Charges | |||
recurring_date | 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.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. |
Charge Validations
The following checks are made by the API when adding a Charge:
- Charge Catalog restrictions are not violated
- Error if the amount is provided and the Catalog does not allow overrides
- Error if quantity provided for non/quantity Catalogs, also checks for whole numbers/fractional and errors is a fraction
- Verify Service is billable when adding a Charge
- Verify there exists an expense GLA that matches the Charge Catalog Expense Type
- Monthly Recurring Charges
- start_date is required for new charge
- error if stop_date is provided for billing complete charges
- error if stop_date is earlier than start_date
- Non-Recurring Charges
- transaction_date is required for new charge
- error if stop_date is provided
- Alternate Recurring Charges (Annual, Semi-Anual, Quarterly)
- start_date is required for new charge
- recurring_date is required for new charge
- error if stop_date is provided for billing complete charges
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/services.json |
...
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service GLA
GLAs can be easily added to a Service. If multiple GLAs need to be added to the service, then separate each value with commas.
Below is the proper format for making a separate request.
Note: "type=GLA" to indicate that this is to add a Service GLA record(s).
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=GLA&field1=value1 ... |
...
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=GLA&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma-separated values, each place in the string corresponds to the same space in other field value strings.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | IntegerThe | RECID of the Service that the GLA is forRECID column from SERVICES table. | ||
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). |
When adding a new GLA to a Service, the API will validate that the Billing Group Format for the Service is compatible with the Format for the new GLA.
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/services.json |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
service_recid | 1 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Contacts
Contacts can be easily added to a Service. If multiple contacts need to be added to Equipment, then separate each value with commas.
Below is the proper format for making a separate request.
Note: "type=CONTACTS" to indicate that this is to add contacts to a Service.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CONTACTS&field1=value1 ... |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | IntegerThe | RECID of the Service that the Contact is forRECID column from SERVICES table. | ||
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service UDFs
User Defined Fields can be easily set for a Service. To get a list of available UDFs for each Service, visit Lists.
Below is the proper format for making a UDF request.
Note: "type=UDFS" to indicate that this is to add UDFs to a Service.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=UDFS&field1=value1 ... |
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | Yes | Integer |
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
|
- udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/services.json |
...
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 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Locations
Locations can be added to Services.
Below is the proper format for making a separate request.
Note: "type=LOCATIONS" to indicate that this is to add Locations to a Service.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=LOCATIONS&field1=value1 ... |
...
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=LOCATIONS&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma-separated values, each place in the string corresponds to the same space in other field value strings.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | IntegerRecid of Service | RECID column from SERVICES table. | ||
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 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Service Equipment
Equipment can be added to a Service.
Below is the proper format for making a separate request.
Note: "type=EQUIPMENT" to indicate that this is to add Equipment to a Service.
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=EQUIPMENT&field1=value1 ... |
If multiple pieces of Equipment are going to be assigned, structure your request as follows:
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=EQUIPMENT&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma-separated values, each place in the string corresponds to the same space in other field value strings.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | IntegerRecid of Service | RECID column from SERVICES table. | ||
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 |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Locating Service Data
Within PCR-360, these menu options list a variety of Grids that can be used to help locate any of the required Required fields.
...