Page Comparison

Table of Contents

outline	true
style	none

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':

...

language	sql

...

Table of Contents

outline	true
style	none

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 Services and related records:

Code Block

language	sql

SELECT * FROM SERVICES_CHARGES;

Controlling Results Count

By default 20, 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	The number 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.

...

Name	Datatype	Searchable	Notes
BILLABLE	Yes/No	Yes	To indicate whether the service item is or is not billable
STATUS_DATE	string	Yes	Shows the date when the service was set to its current status
SERVICE_HOST	string	Yes	The Service Host associated with the service
SERVICE_ID	string	Yes	Service Id (phone_number, etc.)
SERVICE_ID_FMT	string	Yes	Formatted Service Id
CATALOG	string	Yes	Service Catalog name
OWNER	string	Yes	Name of the service owner – either a person or org hierarchy
LOCATIONS_PATH	string	Yes	The hierarchical path to the location of the service; use LOCATIONS when searching
SLA_CATALOG_PATH	string	Yes	The hierarchical path to the SLA of the service; use SLA when searching
SERVICES_STATUS	string	Yes	The current status of the service
SERVICES_UDF	list	No	List of all the User Defined Fields and the selected values for this service
SERVICES_CHARGES	list	No	Charges listed for this service
SERVICES_CONTACTS	list	No	Contacts associated with the service
SERVICES_EQUIPMENT	list	No	Pieces of equipment to be used/listed for this service
SERVICES_EXPENSE_GLA	list	No	Expense G/L Accounts to be used for billing of this service
SERVICES_REMARKS	list	No	List of all remarks/comments for this service

Results Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

    <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
Lists
Lists
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:

Code Block

language	sql

</item>

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.

...

Type

...

Description

...

Extra Parameters*

...

Searchable

...

Results

...

CONTACTS

...

Retrieve available Contacts

...

CTYPE - Type of contact. Example: "worker"

...

yes

...

Code Block

language	sql

</SERVICES_REMARKS> </item> </services> </services>

...

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:

Code Block

language	sql

   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.

Code Block

language	sql

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

...

Parameter

...

Replace With

...

LISTTYPE

...

The type of List to be retrieved. Types can be found below.

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

Parameter	Replace With
LISTTYPE	The type of List to be retrieved. Types can be found below.

List Types

Type	Description	Extra Parameters*
CONTACTS	Retrieve available Contacts	CTYPE - Type of contact. Example: "worker"	yes	Results
DEPTHIER	Retrieve available Departments		Coming Soon	Results
EXPENSE_TYPE	Retrieve available Expense Types		no	Results
GLAS	Retrieve available GLAs		no	Results
LOCATIONS	Retrieve available Locations		yes	Results
CHARGE_CATALOG	Retrieve available Charge Catalogs		yes	Results
SERVICE_CATALOG	Retrieve available Service Catalogs		yes	Results
SERVICE_HOSTS	Retrieve available Service Hosts		no	Results
UDFS	Retrieve available User Defined Fields (UDF)	SERV_CATALOG_RECID (required)	no	Results
SLAS	Retrieve available SLAs		no	Results
POOLS	Retrieve available Service Pools		no	Results
SERVICE_CLASSES	Retrieve available Service Classes		no	Results
SERVICE_HOST_PARTITIONS	Retrieve available Service Host Partitions		no	Results
AUTH_CODE_TYPE	Retrieve available Auth Code Types		no	Results
BANDWIDTH	Retrieve available Bandwidths		no	Results
RATING_GROUP	Retrieve available Rating Groups		no	Results
SERVICE_STATUS	Retrieve available Service Statuses		no	Results

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

Contacts Results
Anchor
Contacts_Results
Contacts_Results

Code Block

language	xml
linenumbers	true

    <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
Department_Hierarchy_Results

...

Department_Hierarchy_Results

Code Block

language	xml
linenumbers	true

    <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
Expense_Types_Results

...

Expense_Types_Results

Code Block

language	xml
linenumbers	true

    <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
GLAs_Results

...

GLAs_Results

Code Block

language	xml
linenumbers	true

    <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

...

Locations Results
...
Anchor
Locations_Results

...

Locations_Results

Code Block

language	xml
linenumbers	true

    <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
Charge_Catalog_Results

...

Charge_Catalog_Results

Code Block

language	xml
linenumbers	true

    <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

...

Catalog Results
...
Anchor
Service_Catalog_Results

...

Service_Catalog_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_catalog>
            <item>
                <RECID>1</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-08-07 13:13:06</MODIFIED_DATE>
                <MODIFIED_BY>lorgana</MODIFIED_BY>
                <STATUS>1</STATUS>
                <SERVICE_NAME>Force Training</SERVICE_NAME>
                <SERVICE_TYPE_LISTS_RECID>1329</SERVICE_TYPE_LISTS_RECID>
                <PARENT_SERV_CATALOG_RECID/>
                <DESCRIPTION>Learn to use the force</DESCRIPTION>
                <CATALOG_DESCRIPTION></CATALOG_DESCRIPTION>
                <CATEGORY>0</CATEGORY>
                <PRORATE>0</PRORATE>
                <ASSIGNABLE>1</ASSIGNABLE>
                <BILLABLE>1</BILLABLE>
                <LOCATION_REQUIRED>0</LOCATION_REQUIRED>
                <REQUIRES_APPROVAL>0</REQUIRES_APPROVAL>
                <ORDERABLE>1</ORDERABLE>
                <DEFAULT_SERVICE_HOSTS_RECID/>
                <WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME>
                <WORKER_REMOVE_TIME>5400</WORKER_REMOVE_TIME>
                <REVENUE_GLA_RECID>4</REVENUE_GLA_RECID>
                <REVENUE_OB_CODES_RECID>1</REVENUE_OB_CODES_RECID>
                <AGING/>
                <REPORT_911>0</REPORT_911>
                <FORMAT/>
                <BILLING_GROUP_RESTRICT/>
                <EQUIPMENT_RESTRICT/>
                <LOCATION_RESTRICT/>
            </item>
        </service_catalog>
    </services>

...

Service Hosts Results
...
Anchor
Service_Hosts_Results

...

Service_Hosts_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_hosts>
            <item>
                <RECID>31</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-12-18 14:45:06</MODIFIED_DATE>
                <MODIFIED_BY>dvader</MODIFIED_BY>
                <STATUS>1</STATUS>
                <NAME>GNetwork</NAME>
                <HOST_TYPES_LISTS_RECID>1198</HOST_TYPES_LISTS_RECID>
                <SWITCH_TYPES_LISTS_RECID/>
                <DEFAULT_NPA/>
                <DEFAULT_NXX/>
                <UPDATE_REQUIRED>0</UPDATE_REQUIRED>
                <DIAL_PLAN/>
                <IP_ADDRESS/>
                <NETWORK_PORT/>
                <USERNAME/>
                <PASSWORD/>
                <VERSION/>
                <WSDL_URI/>
                <HOST_ADDRESS/>
                <DATA_ENCODING/>
                <REQUEST_HEADERS/>
            </item>
        </service_hosts>
    </services>

...

UDFS

...

Retrieve available User Defined Fields (UDF)

...

SERV_CATALOG_RECID (required)

...

no

...

UDFs Results
Anchor
UDFs_Results
UDFs_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <udfs>
            <item>
                <RECID>3</RECID>
                <PRCODE>General</PRCODE>
            </item>
        </udfs>
    </services>

...

SLAS

...

SLAs Results
...
Anchor
SLAs_Results

...

SLAs_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <slas>
            <item>
                <RECID>3</RECID>
                <VALUE>General</VALUE>
            </item>
        </slas>
    </services>

...

POOLS

...

Service Pools Results
...
Anchor
Service_Pools_Results

...

Service_Pools_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <pools>
            <item>
                <RECID>11</RECID>
                <VALUE>IT</VALUE>
            </item>
        </pools>
    </services>

...

Service Classes Results
...
Anchor
Service_Classes_Results

...

Service_Classes_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_classes>
            <item>
                <RECID>16</RECID>
                <VALUE>SC Name</VALUE>
            </item>
        </service_classes>
    </services>

...

Service Host Partitions Results
...
Anchor
Service_Host_Partitions_Results

...

Service_Host_Partitions_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_host_partitions>
            <item>
                <RECID>54</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2015-11-06 15:05:04</MODIFIED_DATE>
                <MODIFIED_BY>cbacca</MODIFIED_BY>
                <SERVICE_HOSTS_RECID>46</SERVICE_HOSTS_RECID>
                <PARTITIONS_NAME>Default</PARTITIONS_NAME>
                <PARTITIONS_DESC>Default Partition</PARTITIONS_DESC>
            </item>
        </service_host_partitions>
    </services>

...

Auth Code Types Results
...
Anchor
Auth_Code_Types_Results

...

Auth_Code_Types_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <auth_code_types>
            <item>
                <RECID>3</RECID>
                <VALUE>General</VALUE>
            </item>
        </auth_code_types>
    </services>

...

BANDWIDTH

...

Retrieve available Bandwidths

...

Bandwidth Results
Anchor
Bandwidth_Results
Bandwidth_Results

...

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <bandwidth>
            <item>
                <RECID>3</RECID>
                <VALUE>1 Gbps</VALUE>
            </item>
        </bandwidth>
    </services>

...

RATING_GROUP

...

Rating Groups Results
...
Anchor
Rating_Groups_Results

...

Rating_Groups_Results

Code Block

language	xml

    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <rating_group>
            <item>
                <RECID>1890</RECID>
                <VALUE>Group_1</VALUE>
            </item>
        </rating_group>
    </services>

...

Service Statuses Results
...
Anchor
Service

...

_Statuses_Results

...

Service_Statuses_Results

Code Block

language	xml
linenumbers	true

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

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

Write Call

Available Fields

Field	Required	Data Type	Options	Default	Notes
recid	no*RECID	only when updating	Integer			Identifier of the record . *See Note Belowto be updated
status	yes	Integer	.Services API Calls v2.1.4.7#Lists		The status of the service.
serv_catalog	yes	Integer	.Services API Calls Recid of the Service Catalog item.
Insert excerpt
Bulk Update	Bulk Update
nopanel	true
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.v2.1.4.7#Lists		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. *See Note Below
owner	no*	Integer	.Services API Calls v2.1.4.7#Lists		Record ID of either the Contact or the Department owner.
owner_type	no*	String	"contact" or "department"		Type of owner
location	no	Integer	.Services API Calls v2.1.4.7#Lists		Recid of location for service.
service_host	no	Integer	.Services API Calls v2.1.4.7#Lists		Recid of Service Host for service.
sla	no	Integer	.Services API Calls v2.1.4.7#Lists		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	.Services API Calls v2.1.4.7#Lists		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	.Services API Calls v2.1.4.7#Lists		Recid of Associated Service.
equipment	no	String	.Services API Calls v2.1.4.7#Lists		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	.Services API Calls v2.1.4.7#Lists		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	.Services API Calls v2.1.4.7#Lists		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	.Services API Calls v2.1.4.7#Lists		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	Services API Calls .Services API Calls v2.1.4.7#Lists		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	.Services API Calls	IF service_type = "data" OR "backbone". Recid of bandwidth record.	auth_code_type	no	Integer	Services API Calls	IF service_type = "authcode". Recid of authcode type.	service_class	no	Integer	Services API Calls	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

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

1

Key	Value
status	Available
serv_catalog	1
service_id	5558675309
status_date	2019/03/18
service_type	Phone
directory	1
report_911	v2.1.4.7#Lists		IF service_type = "data" OR "backbone". Recid of bandwidth record.
auth_code_type	no	Integer	.Services API Calls v2.1.4.7#Lists	IF service_type = "authcode". Recid of authcode type.
service_class	no	Integer	.Services API Calls v2.1.4.7#Lists	IF service_type = "authcode". Recid of Service Class for authcode.

Results

If the request is successful, the Service RECID will be returned returns as follows:toggle-cloak

Cloak

Code Block

language	xml
linenumbers	true

    <service>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <service>54875</service>
    </service>

Service Form App Record

Image Modified

Service Pools

Services can be assigned to one or more Pools.

...

Code Block

language	sql

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

Available Fields

Field	Required	Data Type	Options	Default	Notes	service_recid	yes	Integer	Recid of service	pools	yes	String	One or more Recids of Pools. If multiple, separate with commas. Example: 23,43

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

1

Key	Value
service_recid	1
pools		Required	Data Type	Options	Default	Notes
service_recid	yes	Integer			Recid of service
pools	yes	String			One or more Recids of Pools. If multiple, separate with commas. Example: 23,43

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

Code Block

language	xml
linenumbers	true

    <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

Image Modified

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.

Code Block

language	sql

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

Available Fields

Field	Required	Data Type	Options	Default	Notes
service_recid	yes	Integer			Recid of service
remarks	yes	String			The remark to add to the service

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

...

Key

...

Value

...

service_recid

...

1

...

remarks

...

Test Remark

Results

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

...

Code Block

language	xml
linenumbers	true

    <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

Image Modified

Service Charges

Charges can be easily added to a Service. If multiple Charges charges need to be added to Service, then separate POST requests will need to be made.

...

*Conditionally Requiredif attempting to UPDATE a Service Charge

Field	Required	Data Type	Options	Default	Notes	recid	no	Integer
service_recid	yes	Integer			The RECID of the Service that the charge is for
charge_recid	yes	Integer	Services API Calls			RECID Record ID of the applicable charge catalog. See .Services API Calls v2.1.4.7#Lists about how to retrieve available Charge Catalogs.
description	no	String			The details or description of the charge on the Equipment
amount	no*	DecimalFloat			The amount to be charged. *Required if charge does not have an amount on it.
quantity	no	Integer		1	The quantity Quantity of charge to be used.
prorate	no	Integer	1 or 0	0	Should the charge be prorated when activated
gla	no	Integer	Services API Calls	Recid of GLA to assign to Service Charge	location	no	Integer	Services API Calls	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.

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

Key	Value
service_recid	1
charge_recid	1.
prorate	no	Integer	1 or 0	0	Should the charge be prorated when activated
gla	no	Integer	.Services API Calls v2.1.4.7#Lists		Recid of GLA to assign to Service Charge
location	no	Integer	.Services API Calls v2.1.4.7#Lists		Location that this Charge applies to for the service

Results

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

Cloak

Code Block

language	xml
linenumbers	true

    <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

Image Modified

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.

...

Field	Required	Data Type	Options	Notes
service_recid	yes	Integer		The RECID of the Service that the GLA is for
gla	yes	String	Services API Calls Lists	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	Services API Calls	The type(s) of GLA(s).

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

Default

Key	Value
service_recid	1
gla	1
gla_percent	100
gla_type
gla_type	yes	String	.Services API Calls v2.1.4.7#Lists	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: Toggle cloak

...

Code Block

language	xml
linenumbers	true

    <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

Image Modified

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.

...

Field	Required	Data Type	Options	Default	Notes
service_recid	yes	Integer			The RECID of the Service that the Contact contact is for
contact	yes	String	.Services API Calls v2.1.4.7#Lists		Record ID(s) of the contact(s).

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

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

...

provided:

Code Block

language	xml
linenumbers	true

    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <services>
            <item>123</item>
            <item>124</item>
        </services>
    </services>

Image Removed

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

language	sql

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

Available Fields

...

Field

...

Required

...

Data Type

...

Options

...

Default

...

Notes

...

service_recid

...

Yes

...

The RECID of the Service that the UDF is for

...

See Note Below

...

See Note Below

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

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

...

Key

...

Value

...

service_recid

...

1

...

udf_UDF-RECID1

...

1

...

Service Form Contacts Tab App Record

Image Added

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

language	sql

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			The RECID of the Service that the UDF is for
udf_UDF-RECID	yes	Mixed			UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value

Results

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

...

Code Block

language	xml
linenumbers	true

    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <services>
            <item>5434</item>
            <item>5435</item>
        </services>
    </services>

Image Removed

Service Form UDF Tab App Record

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 locations to a Serviceservice.

Code Block

language	sql

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

...

Field	Required	Data Type	Options	Notes
service_recid	yes	Integer		Recid of Serviceservice
location	yes	Integer	.Services API Calls v2.1.4.7#Lists	Recid(s) of the Locationlocation(s) to assign to the Serviceservice.
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

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

1

Key	Value
service_recid	1
location	1
report_911	1
location_status	show on emergency 911 feed
location_status	yes	Integer	1 = yes; 0 = no	Status of location

Results

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

Cloak

Code Block

language	xml
linenumbers	true

    <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

Image Modified

Service Equipment

Equipment can be added to a Service.

...

Field	Required	Data Type	Options	Default	Notes
service_recid	yes	Integer			Recid of Serviceservice
equipment	yes	String	.Services API Calls v2.1.4.7#Lists		Recid(s) of Equipment to assign to the Service

Call:

...

language	php

...

POST DOMAIN/KEY/services.json

Headers:

...

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

Code Block

language	xml
linenumbers	true

    <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

Image Modified

Locating Service Data

Within PCR-360, these menu options list lists a variety of Grids that can be used to help locate any of the required fields.

...

Page Comparison

Versions Compared

Old Version 72

New Version 73

Key

Read Call

Read Call

Controlling Results Count

Results Toggle cloak

AnchorListsListsLists

Searchable

Searchable

List Types

Contacts Results AnchorContacts_ResultsContacts_Results

Department

Hierarchy Results... AnchorDepartment_Hierarchy_Results

Department_Hierarchy_Results

Expense Types Results... AnchorExpense_Types_Results

Expense_Types_Results

GLAs Results... AnchorGLAs_Results

GLAs_Results

Locations Results... AnchorLocations_Results

Locations_Results

Charge

Catalog Results... AnchorCharge_Catalog_Results

Charge_Catalog_Results

Service

Catalog Results... AnchorService_Catalog_Results

Service_Catalog_Results

Service Hosts Results... AnchorService_Hosts_Results

Service_Hosts_Results

UDFs Results AnchorUDFs_ResultsUDFs_Results

SLAs Results... AnchorSLAs_Results

SLAs_Results

Service Pools Results... AnchorService_Pools_Results

Service_Pools_Results

Service Classes Results... AnchorService_Classes_Results

Service_Classes_Results

Service Host Partitions Results... AnchorService_Host_Partitions_Results

Service_Host_Partitions_Results

Auth Code Types Results... AnchorAuth_Code_Types_Results

Auth_Code_Types_Results

Bandwidth Results AnchorBandwidth_ResultsBandwidth_Results

Rating Groups Results... AnchorRating_Groups_Results

Rating_Groups_Results

Service Statuses Results... AnchorService

_Statuses_Results

Service_Statuses_Results

Write Call

Available Fields

Call:

Headers:

Body:

Results

Service Form App Record

Service Pools

Available Fields

Call:

Headers:

Body:

Results

Service Form Pools Tab App Record

Service Remarks

Available Fields

Call:

Headers:

Body:

Results

Service Form Remarks Tab App Record

Service Charges

Call:

Headers:

Body:

Results

Service Form Charges Tab App Record

Service GLA

Call:

Headers:

Body:

Results

Anchor
Lists
Lists
Lists

Contacts Results
Anchor
Contacts_Results
Contacts_Results

Hierarchy Results
...
Anchor
Department_Hierarchy_Results

Expense Types Results
...
Anchor
Expense_Types_Results

GLAs Results
...
Anchor
GLAs_Results

Locations Results
...
Anchor
Locations_Results

Catalog Results
...
Anchor
Charge_Catalog_Results

Catalog Results
...
Anchor
Service_Catalog_Results

Service Hosts Results
...
Anchor
Service_Hosts_Results

UDFs Results
Anchor
UDFs_Results
UDFs_Results

SLAs Results
...
Anchor
SLAs_Results

Service Pools Results
...
Anchor
Service_Pools_Results

Service Classes Results
...
Anchor
Service_Classes_Results

Service Host Partitions Results
...
Anchor
Service_Host_Partitions_Results

Auth Code Types Results
...
Anchor
Auth_Code_Types_Results

Bandwidth Results
Anchor
Bandwidth_Results
Bandwidth_Results

Rating Groups Results
...
Anchor
Rating_Groups_Results

Service Statuses Results
...
Anchor
Service