...
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.
...
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.
Parameter | Default | Description |
---|---|---|
limit | 20 | 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. |
...
Results
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>1331</total_count> <services> <item> <RECID>2488</RECID> <MODIFIED_DATE>2014-08-22 12:37:49</MODIFIED_DATE> <BILLABLE>Yes</BILLABLE> <STATUS_DATE>2014-07-11 15:35:38</STATUS_DATE> <CAT_RECID>46</CAT_RECID> <SERVICE_HOST/> <SERVICE_ID>5555555555</SERVICE_ID> <SERVICE_ID_FMT>(555) 555-5555</SERVICE_ID_FMT> <CATALOG>Amazing Product</CATALOG> <OWNER>Blue Alert</OWNER> <MODIFIED_BY>PCR User</MODIFIED_BY> <LOCATIONS_PATH/> <SLA_CATALOG_PATH/> <S_SERVICE_STATUS_VALUE>Active</S_SERVICE_STATUS_VALUE> <SERVICE_STATUS>ACTIVE</SERVICE_STATUS> <SERVICES_UDF> <item> <LABEL>Label</LABEL> <VALUE>value</VALUE> </item> </SERVICES_UDF> <SERVICES_CHARGES> <item> <RECID>956</RECID> <TENANTS_RECID>0</TENANTS_RECID> <MODIFIED_DATE>2014-07-21 14:55:11</MODIFIED_DATE> <MODIFIED_BY>PCR User</MODIFIED_BY> <SERVICES_RECID>29</SERVICES_RECID> <CHRG_CATALOG_RECID>57</CHRG_CATALOG_RECID> <DESCRIPTION/> <AMOUNT>50</AMOUNT> <BILL_DATE/> <PRORATE>0</PRORATE> <EXPENSE_GLA_RECID/> <QUANTITY/> <CATALOG_NAME>name</CATALOG_NAME> <CATALOG_DESCRIPTION>description</CATALOG_DESCRIPTION> <CATALOG_AMOUNT>199</CATALOG_AMOUNT> </item> </SERVICES_CHARGES> <SERVICES_CONTACTS> <item> <RECID>2523</RECID> <TENANTS_RECID>0</TENANTS_RECID> <MODIFIED_DATE>2013-06-05 10:25:56</MODIFIED_DATE> <MODIFIED_BY>PCR User</MODIFIED_BY> <SERVICES_RECID>1767</SERVICES_RECID> <CONTACTS_RECID>34</CONTACTS_RECID> <FIRST_NAME>John</FIRST_NAME> <LAST_NAME>Doe</LAST_NAME> </item> </SERVICES_CONTACTS> <SERVICES_EQUIPMENT> <item> <RECID>71</RECID> <TENANTS_RECID>0</TENANTS_RECID> <MODIFIED_DATE>2015-03-26 13:38:34</MODIFIED_DATE> <MODIFIED_BY>PCR User</MODIFIED_BY> <SERVICES_RECID>1697</SERVICES_RECID> <EQUIPMENT_RECID>3078</EQUIPMENT_RECID> <SERVICE_ID>0000001234</SERVICE_ID> <SERV_CATALOG_RECID>56</SERV_CATALOG_RECID> <OWNER_CONTACTS_RECID/> <OWNER_DEPT_HIERARCHY_RECID>47</OWNER_DEPT_HIERARCHY_RECID> <BILLABLE>No</BILLABLE> <SERVICE_STATUS_LISTS_RECID>1321</SERVICE_STATUS_LISTS_RECID> <STATUS_DATE>2015-03-10 13:24:27</STATUS_DATE> <SERVICE_HOSTS_RECID>26</SERVICE_HOSTS_RECID> <SLA_CATALOG_RECID/> <LOCATIONS_RECID>66</LOCATIONS_RECID> <REFERENCE/> <ESSENTIAL>0</ESSENTIAL> <BILLING_GROUPS_RECID/> <SERVICE_ID_FMT>(000) 000-1234</SERVICE_ID_FMT> <EQP_STATUS_LISTS_RECID>1175</EQP_STATUS_LISTS_RECID> <EQP_CATALOG_RECID>71</EQP_CATALOG_RECID> <SERIAL_NUM>006A</SERIAL_NUM> <SERIAL_NUM_BARCODE/> <EQUIPMENT_ID>006A</EQUIPMENT_ID> <ASSET_TAG/> <CONSUMED>No</CONSUMED> <PURCHASE_PRICE/> <RECEIVED_DATE/> <BILLED_DATE/> <CARD_NUMBER/> <PARENT_EQUIPMENT_RECID/> <CABLING_EQP_TYPE_LISTS_RECID/> <IP4_GATEWAY/> <IP6_GATEWAY/> <LAN_NAME/> <MAC_ADDRESS/> <IP4_ADDRESS/> <IP6_ADDRESS/> <IP4_SUBNET_MASK/> <IP6_SUBNET_MASK/> <IP4_GATEWAY_ADDRESS/> <IP6_GATEWAY_ADDRESS/> <HOST_NAME/> <EQP_CONDITION_LISTS_RECID/> <ORDERED_DATE/> <UNITS/> <WARRANTY_END_DATE/> <USE_DHCP>0</USE_DHCP> <PRIVATE>0</PRIVATE> <STATUS>Active</STATUS> <PART_NUMBER>ABC123</PART_NUMBER> <PART_NUM_BARCODE/> <DESCRIPTION>ABC123</DESCRIPTION> <MANUFACTURER/> <MANU_PART_NUM/> <CATALOG_DESCRIPTION/> <CATEGORY>No</CATEGORY> <PRORATE>No</PRORATE> <ASSIGNABLE>No</ASSIGNABLE> <CABLING_EQUIPMENT>Yes</CABLING_EQUIPMENT> <ASSET>No</ASSET> <LOCATION_REQUIRED>No</LOCATION_REQUIRED> <ORDERABLE>0</ORDERABLE> <CONSUMABLE>No</CONSUMABLE> <PROVISIONED>0</PROVISIONED> <REVENUE_GLA_RECID>45</REVENUE_GLA_RECID> <REVENUE_OB_CODES_RECID>6</REVENUE_OB_CODES_RECID> <EXPENSE_OB_CODES_RECID>6</EXPENSE_OB_CODES_RECID> <WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME> <WORKER_REMOVE_TIME>3600</WORKER_REMOVE_TIME> <MAX_QUANTITY/> <PARENT_EQP_CATALOG_RECID/> <WARRANTY_LENGTH_LISTS_RECID/> <HEIGHT/> <WIDTH/> <SLOTS/> <UNIT_LISTS_RECID>1342</UNIT_LISTS_RECID> <HAS_UNITS>0</HAS_UNITS> <CONTIGUOUS>0</CONTIGUOUS> </item> </SERVICES_EQUIPMENT> <SERVICES_EXPENSE_GLA> <item> <PERCENT>100</PERCENT> <Type>Default</Type> <GLA_FULL_CODES_0>100 > 200 > 300 > 400</GLA_FULL_CODES_0> </item> </SERVICES_EXPENSE_GLA> <SERVICES_REMARKS> <item> <RECID>74</RECID> <TENANTS_RECID>0</TENANTS_RECID> <MODIFIED_DATE>2013-07-05 14:04:51</MODIFIED_DATE> <MODIFIED_BY>PCR User</MODIFIED_BY> <SERVICES_RECID>1697</SERVICES_RECID> <REMARKS>These are the remarks</REMARKS> </item> </SERVICES_REMARKS> </item> </services> </services> |
Anchor | ||||
---|---|---|---|---|
|
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.
...
Type | Description | Extra Parameters* | ||
---|---|---|---|---|
CONTACTS | Retrieve available Contacts | CTYPE - Type of contact. Example: "worker" | yes | |
DEPTHIER | Retrieve available Departments | Coming Soon | ||
EXPENSE_TYPE | Retrieve available Expense Types | no | ||
GLAS | Retrieve available GLAs | no | ||
LOCATIONS | Retrieve available Locations | yes | ||
CHARGE_CATALOG | Retrieve available Charge Catalogs | yes | ||
SERVICE_CATALOG | Retrieve available Service Catalogs | yes | ||
SERVICE_HOSTS | Retrieve available Service Hosts | no | ||
UDFS | Retrieve available User Defined Fields (UDF) | SERV_CATALOG_RECID (required) | no | |
SLAS | Retrieve available SLAs | no | ||
POOLS | Retrieve available Service Pools | no | ||
SERVICE_CLASSES | Retrieve available Service Classes | no | ||
SERVICE_HOST_PARTITIONS | Retrieve available Service Host Partitions | no | ||
AUTH_CODE_TYPE | Retrieve available Auth Code Types | no | ||
BANDWIDTH | Retrieve available Bandwidths | no | ||
RATING_GROUP | Retrieve available Rating Groups | no | ||
SERVICE_STATUS | Retrieve available Service Statuses | no |
*Extra Parameters can be appended to the URL in standard Query String fashion.
Contacts Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <contacts> <item> <RECID>809</RECID> <SERVICE_REP>Doe, John</SERVICE_REP> <STATUS>1</STATUS> <CONTACT_TYPE_LISTS_RECID>1147</CONTACT_TYPE_LISTS_RECID> <C_TITLE_VALUE/> <C_TITLE_CODE/> <CTYPE_CONTACT_TYPE_VALUE>User</CTYPE_CONTACT_TYPE_VALUE> <CTYPE_CONTACT_TYPE_CODE>USER</CTYPE_CONTACT_TYPE_CODE> </item> </contacts> </services> |
Department Hierarchy Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <depthier> <item> <RECID>24</RECID> <DH_NAME>Facilities</DH_NAME> <STATUS>1</STATUS> <DEFAULT_SLA_DESC/> <DEFAULT_INCI_SLA_DESC/> <BG_NAME>Admin</BG_NAME> <DEPT_HIERARCHY_PATH>FM</DEPT_HIERARCHY_PATH> <DEPT_HIERARCHY_PATH_TOOLTIP>FM</DEPT_HIERARCHY_PATH_TOOLTIP> <NAME_AND_BG>FM - Admin</NAME_AND_BG> </item> </depthier> </services> |
Expense Types Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <expense_type> <item> <RECID>1182</RECID> <VALUE>Default</VALUE> </item> </expense_type> </services> |
GLAs Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <glas> <item> <RECID>1</RECID> <NAME>ACCOUNT</NAME> <DESCRIPTION>GLA Format for Account Billing Group</DESCRIPTION> </item> </glas> </services> |
Locations Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <locations> <item> <RECID>261</RECID> <TENANTS_RECID>0</TENANTS_RECID> <MODIFIED_DATE>2015-01-02 16:47:00</MODIFIED_DATE> <MODIFIED_BY>hsolo</MODIFIED_BY> <STATUS>1</STATUS> <WAREHOUSE_FLAG>0</WAREHOUSE_FLAG> <REPORT_911>0</REPORT_911> <DEFAULT_WH_LOCATIONS_RECID/> <PARENT_LOCATIONS_RECID>7</PARENT_LOCATIONS_RECID> <LOCATION_TYPE_LISTS_RECID/> <NAME>Tatooine</NAME> <BUILDING_NUMBER/> <BUILDING_ADDRESSES_RECID/> <MASTER_DEFAULT_WAREHOUSE>0</MASTER_DEFAULT_WAREHOUSE> <LATITUDE/> <LONGITUDE/> <DEFAULT_RETURN_WAREHOUSE>0</DEFAULT_RETURN_WAREHOUSE> <DEFAULT_RWH_LOCATIONS_RECID/> <COMMUNITY_NAME/> <L_LOCATION_TYPE_VALUE/> <L_LOCATION_TYPE_CODE/> </item> </locations> </services> |
Charge Catalog Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>64</count> <total_count>64</total_count> <charge_catalog> <item> <RECID>167</RECID> <NAME>Starship Detailing</NAME> <DESCRIPTION>1-time charge for cleaning of starships</DESCRIPTION> <AMOUNT>126587</AMOUNT> <CHARGE_TYPE_LISTS_RECID>1981</CHARGE_TYPE_LISTS_RECID> <EXPENSE_TYPE_LISTS_RECID>1182</EXPENSE_TYPE_LISTS_RECID> <PARENT_CHRG_CATALOG_RECID/> <REVENUE_GLA_RECID>1</REVENUE_GLA_RECID> <USE_QUANTITY>1</USE_QUANTITY> <TAXABLE>0</TAXABLE> <ALLOW_OVERRIDE>1</ALLOW_OVERRIDE> <CC_CHARGE_TYPE_VALUE>1 time</CC_CHARGE_TYPE_VALUE> <CC_CHARGE_TYPE_CODE>1_TIME</CC_CHARGE_TYPE_CODE> <CC_EXPENSE_TYPE_VALUE>Default</CC_EXPENSE_TYPE_VALUE> <CC_EXPENSE_TYPE_CODE>DEFAULT</CC_EXPENSE_TYPE_CODE> </item> </charge_catalog> </services> |
...
Service Statuses Results
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <service_status> <item> <RECID>3</RECID> <VALUE>Active</VALUE> </item> </service_status> </services> |
Write Call
...
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
RECID | only when updating | Integer | Identifier of the record to be updated | ||
status | yes | IntegerLists | The status of the service. | ||
serv_catalog | yes | IntegerLists | Recid of the Service Catalog item. | ||
service_id | yes | String | Service ID of this service | ||
service_id_fmt | no | String | Formatted version of the Service ID | ||
owner | no* | IntegerLists | Record ID of either the Contact or the Department owner. | ||
owner_type | no* | String | "contact" or "department" | Type of owner | |
location | no | IntegerLists | Recid of location for service. | ||
service_host | no | IntegerLists | Recid of Service Host for service. | ||
sla | no | IntegerLists | 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 | IntegerLists | 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 | ||
assoc_service | no | IntegerLists | Recid of Associated Service. | ||
equipment | no | StringLists | Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875. | ||
contact | no | StringLists | 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 | StringLists | 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 | IntegerLists | 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* | StringLists | 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 | IntegerLists | IF service_type = "data" OR "backbone". Recid of bandwidth record. | ||
auth_code_type | no | IntegerLists | IF service_type = "authcode". Recid of authcode type. | ||
service_class | no | IntegerLists | IF service_type = "authcode". Recid of Service Class for authcode. |
...
If the request is successful, the Service RECID will be returns as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<service> <status>success</status> <page>1</page> <count>1</count> <total_count>0</total_count> <service>54875</service> </service> |
...
If the request is successful, the Recid(s) of the linking records will be returned in same order as provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>0</total_count> <services> <item>2312</item> <item>2313</item> </services> </services> |
Service Form Pools Tab App Record
Service Remarks
...
If the request is successful, the Recid of the remark record will be returned as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>0</total_count> <services>456231</services> </services> |
Service Form Remarks Tab App Record
Service Charges
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | The RECID of the Service that the charge is for | ||
charge_recid | yes | Integer | Record ID of the applicable charge catalog. See Lists Services API Calls#Lists about how to retrieve available Charge Catalogs. | ||
description | no | String | The details or description of the charge on the Equipment | ||
amount | no* | Float | The amount to be charged. *Required if charge does not have an amount on it. | ||
quantity | no | Integer | 1 | Quantity of charge to be used. | |
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated |
gla | no | IntegerLists | Recid of GLA to assign to Service Charge | ||
location | no | IntegerLists | Location that this Charge applies to for the service |
...
If the request is successful, the RECID of the new Service charge is returned as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>1</total_count> <services>58337</services> </services> |
Service Form Charges Tab App Record
Service GLA
...
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 | StringLists | The type(s) of GLA(s). |
Results
If the request is successful, the RECID(s) of the new Service GLA records will be returned in the same order as provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>1</total_count> <services> <item>234</item> <item>235</item> </services> </services> |
Service Form GLA Tab App Record
Service Contacts
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | The RECID of the Service that the contact is for | ||
contact | yes | StringLists | Record ID(s) of the contact(s). |
...
If the request is successful, the RECID(s) of the new service contact records will be returned in the same order as provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>1</total_count> <services> <item>123</item> <item>124</item> </services> </services> |
Service Form Contacts Tab App Record
Service UDFs
...
If the request is successful, the RECID(s) of the new Service UDF records will be returned in the same order as provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>1</total_count> <services> <item>5434</item> <item>5435</item> </services> </services> |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | Recid of service | ||
location | yes | IntegerLists | 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 |
...
If the request is successful, the Recid of the Service Location record(s) will be returned in the same order as provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>0</total_count> <services> <item>4545</item> <item>4546</item> </services> </services> |
Service Form Location Tab App Record
Service Equipment
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
service_recid | yes | Integer | Recid of service | ||
equipment | yes | StringLists | Recid(s) of Equipment to assign to the Service |
...
If the request is successful, the Recid of the Service Equipment record(s) will be returned in the order provided:
Code Block | ||||
---|---|---|---|---|
| ||||
<services> <status>success</status> <page>1</page> <count>1</count> <total_count>0</total_count> <services> <item>234</item> <item>235</item> </services> </services> |
Service Form Equipment Tab App Record
Locating Service Data
Within PCR-360, these menu options lists a variety of Grids that can be used to help locate any of the required fields.
Child pages (Children Display) | ||||
---|---|---|---|---|
|