.Services API Calls v2019.1

Read Call

In an effort to make the PCR-360 API more flexible, PCR has made the decision to no longer create individual endpoints for all the different data types. Instead, PCR is encouraging Users to use the SQL endpoint with a structured SELECT statement to retrieve exactly the data you want. Please see the SQL endpoint documentation for more information.

Example SELECT query for retrieving RECID's of 'Services' and 'Charges':

SELECT * FROM SERVICES_CHARGES;

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.

Note: These parameters are added in addition to any fields from the specific data types.

Response Data

Results

Lists

When inserting or updating Service records, it is sometimes necessary to provide values that exist elsewhere in the system. The LIST method can help to retrieve available options for these values.

Below is how to make a LIST request:

   GET http://DOMAIN/api/API_KEY/services.OUTPUT?LIST=LISTTYPE

Searchable

If a LISTTYPE is designated as searchable in the table below, adding the "SEARCH" param will return values that contain the provided value.

   GET http://DOMAIN/api/API_KEY/services.OUTPUT?LIST=LISTTYPE&SEARCH=test

List Types

*Extra Parameters can be appended to the URL in standard Query String fashion.

Write Call

Available Fields

Note: When updating a record, either the "recid" or "service_id_fmt" is required. 

The following is generalized functionality that can appear on various Services grids, based on how those Services behave.  Most commonly this functionality refers to Phone, Trunk, Authorization Code and Other Services.

Age Selected

The Aging Process in PCR-360 is an automated data removal process that will delete old information from Inactive Services. Examples of data that will be removed are the Owner, Service Host, and Location fields. Some information can be deleted or remain on the Service for future use on the Service ID. An example is the User Defined Fields (UDFs) can have the option to have their data persist or be scrubbed on Aging with the Aging Persist flag. Another example is the Configuration Option DELETE_CHARGES_DURING_AGING which will allow you to delete old Charges or leave them on the Service. Sometimes it can be necessary to manually "Age" a Service to make it active again. This process is normally handled automatically by either the setting on the Service Catalog or the Tenant Management Aging fields.

To manually Age a Service select the Service and click the button.

There are a few requirements before a Service can be aged manually:

1. The Service must be 'Inactive'.
2. There cannot be any active recurring Charges. If there are active recurring Charges and the Service is Inactive, the status of the Services will first have to be made 'Active' to stop the Charges. Then the Service can be set to Inactive once again.
3. There cannot be any unbilled Charges. If there are, the billing process must run first to ensure proper billing for the Service.

The History Report of a Service will still show all the old data of the Service.

Once a Service has been "Aged" successfully, PCR-360 will change the status to available so that the Service ID can be reused on Service Orders for a new Owner.

There may occur a situation where a Service is desired to no longer be available after it has been "Aged" (such as if the number was receiving harassing phone calls). The best way to handle this is to set the Service to a Service Pool with Services that are designated "Do Not Use". By adding the Service to this Pool, the Service will be designated to not be used simply by being in the "Do Not Use" Pool. Additionally, the Administrator can add a UDF that will persist through Aging as well, with the flag "Verify Field Data" set to call attention to UDF. Using this method provides a backstop to the need to not use the Service since a Remark could easily be overlooked when re-assigning the Service with an Add Action.

Adding a Range of Services

Users can add Services in bulk by clicking on the  button located on the Grid Toolbar above the Services grid. In the window, click the Search Icon in the 'Service Type' field and select a type from the list, enter a range of phone numbers to a 'Service Type', and click the button. Each phone number included within the specified range will appear as a separate Service in the Services grid.

Estimate Billing

When a User selects a Service and clicks the  button on the Grid, they will open the Estimate Billing form. From this Form, a User can generate an estimation of expected Charges over a provided Billing Period, by clicking the  button.

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the Service RECID will be returned as follows:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=POOLS&field1=value1 ...

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the Recid(s) of the linking records will be returned in the same order as provided:

Service Remarks

Remarks can be added to services.

Below is the proper format for making a separate request. Note "type=REMARK" to indicate that this is to add a remark to a service.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=REMARK&field1=value1 ...

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the Recid of the remark record will be returned as follows:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CHARGES&field1=value1 ...

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the RECID of the new Service charge is returned as follows:

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).

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=GLA&field1=value1 ...

If multiple GLAs are to be set, structure your request as follows:

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.

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the RECID(s) of the new Service GLA records will be returned in the same order as provided:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CONTACTS&field1=value1 ...

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the RECID(s) of the new service contact records will be returned in the same order as provided:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=UDFS&field1=value1 ...

Available Fields

• udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the RECID(s) of the new Service UDF records will be returned in the same order as provided:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=LOCATIONS&field1=value1 ...

If multiple locations are to be set, structure your request as follows:

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.

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the Recid of the Service Location record(s) will be returned in the same order as provided:

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.

POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=EQUIPMENT&field1=value1 ...

If multiple Equipment are to be assigned, structure your request as follows:

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.

Available Fields

Call:

POST DOMAIN/KEY/services.json

Headers:

Body:

Results

If the request is successful, the Recid of the Service Equipment record(s) will be returned in the order provided:

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 fields.

• Main > Services
• Main > Catalog