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

Code Block

language	sql

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.

...

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.

Response Data

...

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

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

Code Block

language	sql

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.

Parameter	Default	Description
limit	20	The 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.

Response Data

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

...

Service Status Results

Type

Description

Extra Parameters*

Searchable

Results

CONTACTS

Retrieve available Contacts

CTYPE - Type of contact. Example: "worker"

yes

Contacts Results

Toggle cloak

Cloak

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>

DEPTHIER

Retrieve available Department Hierarchies

Coming Soon

Department Hierarchy Results

Toggle cloak

Cloak

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_TYPE

Retrieve available Expense Types

no

Expense Types Results

Toggle cloak

Cloak

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

Retrieve available GLAs

no

GLAs Results

Toggle cloak

Cloak

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

Retrieve available Locations

yes

Locations Results

Toggle cloak

Cloak

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

Retrieve available Charge Catalogs

yes

Charge Catalog Results

Toggle cloak

Cloak

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

Retrieve available Service Catalogs

yes

Service Catalog Results

Toggle cloak

Cloak

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

Retrieve available Service Hosts

no

Service Hosts Results

Toggle cloak

Cloak

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

Toggle cloak

Cloak

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

Retrieve available SLAs

no

SLAs Results

Toggle cloak

Cloak

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

Retrieve available Service Pools

no

Service Pools Results

Toggle cloak

Cloak

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

Retrieve available Service Classes

no

Service Classes Results

Toggle cloak

Cloak

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

Retrieve available Service Host Partitions

no

Service Host Partitions Results

Toggle cloak

Cloak

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_TYPE

Retrieve available Auth Code Types

no

Auth Code Types Results

Toggle cloak

Cloak

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

no

Bandwidth Results

Toggle cloak

Cloak

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

Retrieve available Rating Groups

no

Rating Groups Results

Toggle cloak

Cloak

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_STATUS

Retrieve available Service Statuses

no

Toggle cloak

Cloak

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*

Integer

Identifier of the record. *See Note Below

status

yes

Integer

Services API Calls

The status of the service.

serv_catalog

yes

Integer

Services API Calls

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.

service_id_fmt

no*

String

Formatted version of the Service ID. *See Note Below

owner

no*

Integer

Services API Calls

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

Recid of location for service.

service_host

no

Integer

Services API Calls

Recid of Service Host for service.

sla

no

Integer

Services API Calls

Recid of SLA for service.

reference

no

String

Reference for service

billable

no

</item>
        </rating_group>
    </services>

SERVICE_STATUS

Retrieve available Service Statuses

no

Service Status Results

Toggle cloak

Cloak

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

Insert excerpt

	SQL API Calls
	SQL API Calls
nopanel	true

Insert excerpt

	Custom API
	Custom API
nopanel	true

Available Fields

(s) of Contacts to add to Service. If multiple contacts are to be assigned, separate recids with commas. Example: 1234,7894.

Field

Required

Data Type

Options

Default

Notes

recid

no*

Integer

Identifier of the record. *See Note Below

status

yes

Integer

Services API Calls

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. The service_id field can be formatted or unformatted. The service_id cannot be updated. *See Note Below.

owner

no*

Integer

Services API Calls

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

Services API Calls

Recid of location for service.

service_host

no

Integer

Services API Calls

Recid of Service Host for service.

sla

no

Integer

Services API Calls

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

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

Recid of Associated Service.

equipment

no

String

Services API Calls

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

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

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

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

Services API Calls

List Value(s) of Expense Type(s). *Required if GLA is specified.

Call:

Code Block

language	php

POST DOMAIN/KEY/services.json

Headers:

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

Body:

Key	Value
status	Available
serv_catalog	1
service_id	5558675309
status_date	2019/03/18
directory	1
report_911	1

Results

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

Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": "0",
    "service": 54875
}

Image Added

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

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 column from SERVICES table.
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:

2019/03/18typedirectoryreport_911

Key	Value
status	Available
serv_catalog	1
service_id	5558675309
status_date
service_	Phone	recid	1
pools	1

Results

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

Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

{
   <service> "status": "success",
    "page": 1,
<status>success</status>    "count": 1,
   <page>1</page>
  "total_count": "0",
    "services": [
<count>1</count>        {
<total_count>0</total_count>         <service>54875</service>   "item":  </service>

Image Removed

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

language	sql

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

2312,
			"item": 2313
        }
    ]
}

Image Added

Service Remarks

Remarks can be added to services.

Available Fields

Field	Required	Data Type	Options	Default	Notes
service_recid	yes	Integer

Recid of service

pools

		RECID column from SERVICES table.
remarks	yes	String

One or more Recids of Pools. If multiple, separate with commas. Example: 23,43

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
type	REMARKS
service_recid	1
poolsremarks	1Test Remark

Results

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

Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
    "page": 1,
<status>success</status>    "count": 1,
   <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
 "total_count": "0",
    "services":   <services>
            <item>2312</item>
            <item>2313</item>
        </services>
    </services>456231
}

Image Modified

Service

...

Charges

Remarks can be added to servicesCharges 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=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

...

a separate request.

Code Block

language	phpsql

POST http://DOMAIN/api/API_KEY/services.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

...

Key

...

Value

...

service_recid

...

1

...

remarks

...

Test Remark

Results

...

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>

Image Removed

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

language	sql

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

Available Fields

...

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 of the applicable charge catalog.

...

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.

...

quantity

...

no

...

Integer

...

1

...

The quantity of charge to be used.

...

prorate

...

no

...

Integer

...

1 or 0

...

0

...

Should the charge be prorated when activated

...

gla

...

no

...

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

...

.OUTPUT?type=CHARGES&field1=value1 ...

Available Fields

Field	Required	Data Type	Options	Default	Notes
recid	no	Integer			*Conditionally Requiredif attempting to UPDATE a Service Charge RECID for charges reads as "SERV1234" but when using that RECID for the API you only need the numbers, so "1234" from the example.
service_recid	yes	Integer			RECID column from SERVICES table.
charge_recid	no*	Integer	Services API Calls		RECID 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 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	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
start_date	no	String	MRC ARC		The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges.
stop_date	no	String	MRC ARC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges
recurring_date	no	String	ARC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Alternate Recurring Charges
transaction_date	no	String	NRC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Non-Recurring Charges
effective	no	String	today, backdate	today	Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date.

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

language	php

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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
    "page": 1,
<status>success</status>         <page>1</page>
        <count>1</count>
  "count": 1,
     <total_count>1</"total_count>
count": "1",
    "services":   <services>58337</services>
    </services>58337
}

Image Modified

Service GLA

...

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

language	sql

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

...

Code Block

language	sql

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	Notes
service_recid	yes	IntegerThe		RECID of the Service that the GLA is forRECID column from SERVICES table.
gla	yes	String	Services API Calls	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).

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

language	php

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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
    "page": 1,
<status>success</status>         <page>1</page>
        <count>1</count>
  "count": 1,
     <total_count>1</"total_count>
count": "1",
    "services": [
 <services>       {
     <item>234</item>       "item": 234,
			"item": 235
  <item>235</item>      }
  </services>  ]
  </services>}

Image Modified

Service Contacts

...

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

language	sql

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	Services API Calls		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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
      <status>success</status>"page": 1,
    "count": 1,
  <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
   "total_count": "1",
    "services": [
<services>        {
    <item>123</item>        "item": 123,
			"item": 124
 <item>124</item>       }
 </services>   ]
 </services>}

Image Modified

Service UDFs

...

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

		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 See Note Below
udf_UDF-IDENTIFIER	Yes*	Mixed	IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value 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

...

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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
      <status>success</status>"page": 1,
      "count": 1,
 <page>1</page>         <count>1</count>
        <total_count>1</total_count>
  "total_count": "1",
    "services": <services>[
        {
   <item>5434</item>         "item": 5434,
			"item": 5435
<item>5435</item>        }
</services>    ]
</services>}

Image Modified

Service Locations

...

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

language	sql

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

...

Code Block

language	sql

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	Notes
service_recid	yes	IntegerRecid of Service		RECID column from SERVICES table.
location	yes	Integer	Services API Calls	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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
    "page": 1,
<status>success</status>      "count": 1,
  <page>1</page>  "total_count": "0",
     <count>1</count>"services": [
        <total_count>0</total_count>{
        <services>    "item": 4545,
       <item>4545</item>             <item>4546</item>"item": 4546
        }
</services>    ]
</services>}

Image Modified

Service Equipment

...

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

language	sql

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

language	sql

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	Services API Calls		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

Code Block

language	xml
linenumbers	true

{
   <services> "status": "success",
    "page": 1,
<status>success</status>    "count": 1,
   <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
 "total_count": "0",
    "services":  [
<services>        {
    <item>234</item>        "item": 234.
   <item>235</item>			"item": 235
        }
</services>    ]
</services>}

Image Modified

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.

...

Page Comparison

Versions Compared

Old Version 68

New Version Current

Key

Read Call

Controlling Results Count

Response Data

Read Call

Controlling Results Count

Response Data

Write Call

Available Fields

Write Call

Available Fields

Call:

Headers:

Body:

Results

Service Pools

Available Fields

Call:

Headers:

Body:

Results

Service Pools

Service Remarks

Available Fields

Call:

Headers:

Body:

Results

Service

Charges

Available Fields

Headers:

Body:

Results

Service Charges

Available Fields

Available Fields

Call:

Body:

Results

Service GLA

Call:

Body:

Service Contacts

Body:

Results

Service UDFs

Available Fields

Call:

Body:

Service Locations

Body:

Service Equipment

Body:

Results

Locating Service Data