Table of Contents | ||||
---|---|---|---|---|
|
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
Table of Contents | ||||
---|---|---|---|---|
|
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.
...
Remember, OUTPUT is replaced by the desired data type you want returned. Making a Request
Controlling Results Count
...
Name | Datatype | Searchable | Notes |
---|---|---|---|
BILLABLE | Yes/No | Yes | To indicate whether the equipment Equipment item is or is not billableBillable. |
EQUIPMENT_ID | string | Yes | Unique identifier of a piece of equipmentEquipment; this is required for data equipmentEquipment. |
ASSET_TAG | string | Yes | Unique identifier of a piece of equipmentEquipment; this is required for assetsAssets. |
SERIAL_NUM | string | Yes | A unique identifier for one individual instance of a piece of equipmentEquipment; often supplied by the manufacturer. |
PURCHASE_PRICE / | number | Yes | The price paid upon purchase of the equipmentEquipment. Searches can be exact match, greater than, or less than a specified value, respectively. |
CONSUMED | Yes/No | Yes | Shows whether or not an item from inventory is now in use. |
RECEIVED_DATE | string | Yes | Date the piece of equipment Equipment was received. |
BILLED_DATE | string | Yes | Date the piece of equipment Equipment was billed. |
CATALOG | string | Yes | Equipment part number. |
OWNER | string | Yes | The Contact or Dept Hierarchy that owns this piece of equipmentEquipment. |
DEPT_HIERARCHY_PATH | string | No | If OWNER is Dept Hierarchy, this will list the hierarchical path to the OWNER. |
LOCATIONS_PATH | string | Yes | The full hierarchical path to the location Location of the piece of equipmentEquipment; use LOCATIONS for search. |
EQP_STATUS | string | Yes | Current status of the piece of equipmentEquipment. Use STATUS for search. |
EQUIPMENT_UDF | list | No | List of all the User Defined Fields and the selected values for this piece of equipmentEquipment. |
EQUIPMENT_CHARGES | list | No | Charges listed for the piece of equipmentEquipment. |
EQUIPMENT_CONTACTS | list | No | Contacts associated with the piece of equipmentEquipment. |
EQUIPMENT_EXPENSE_GLA | list | No | Expense G/L Accounts to be used for billing for the piece of equipmentEquipment. |
EQUIPMENT_REMARKS | list | No | List of all remarks/comments for the piece of equipmentEquipment. |
Results
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
When inserting or updating Equipment 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:
...
CABLING_EQP_TYPE
...
Retrieve available Cabling Equipment Types
...
no
...
...
EQP_CONDITION
...
Retrieve available Equipment Conditions
...
no
...
...
EQP_STATUS
...
Retrieve available Equipment Statuses
...
no
...
...
VLANS
...
Retrieve available VLANs
...
no
...
...
Code Block | |
---|---|
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 |
---|
GET http://DOMAIN/api/API_KEY/equipment.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*
...
Searchable
...
CONTACTS
...
Retrieve available Contacts
...
CTYPE - Type of contact. Example: "worker"
...
yes
...
...
DEPTHIER
...
Retrieve available Departments
...
Coming Soon
...
...
EQP_CATALOG
...
Retrieve available Equipment Catalogs
...
yes
...
...
EXPENSE_TYPE
...
Retrieve available Expense Types
...
no
...
...
GLAS
...
Retrieve available GLAs
...
no
...
...
LOCATIONS
...
Retrieve available Locations
...
yes
...
...
UDFS
...
Retrieve available User Defined Fields (UDF)
...
eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53"
...
no
...
|
Lists
Anchor | ||||
---|---|---|---|---|
|
When inserting or updating Equipment 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 |
---|
GET http://DOMAIN/api/API_KEY/equipment.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 |
---|
GET http://DOMAIN/api/API_KEY/equipment.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* | Searchable | Results | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CONTACTS | Retrieve available Contacts | CTYPE - Type of contact. Example: "worker" | yes | Contacts
|
...
...
DEPTHIER | Retrieve available Departments | Coming Soon | Department Hierarchy
|
...
EQP_CATALOG | Retrieve available Equipment Catalogs | yes | Equipment Catalog
| ||||||||||||
EXPENSE_TYPE | Retrieve available Expense Types |
...
...
no | Expense Types
| |||||||||||
GLAS | Retrieve available GLAs |
...
...
no |
...
GLA
| |||||||||||
LOCATIONS | Retrieve available Locations |
...
...
yes |
...
Locations
| |||||||||||
UDFS |
...
Retrieve available User Defined Fields (UDF) | eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53" | no | UDF
| |||||||||||
CABLING_EQP_TYPE | Retrieve available Cabling Equipment Types |
...
...
no |
...
Cabling Equipment Types |
...
| |||||||||||
EQP_CONDITION | Retrieve available Equipment Conditions | no | Equipment Conditions |
...
...
| |||||||||||
EQP_STATUS | Retrieve available Equipment Statuses |
...
...
no |
...
Equipment Statuses |
...
| |||||||||||
VLANS | Retrieve available VLANs |
...
...
no |
...
VLAN |
...
|
Write Call
Available Fields
Field | Required | Data Type | Options | Default | Notes | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RECIDonly | when updatingno* | Integer | Identifier of the record to be updated | ||||||||||||||||||
status | yes | IntegerLists | Lists
| The status of the equipmentEquipment | |||||||||||||||||
eqp_catalog | yes | IntegerLists | Lists
| Recid of the Equipment Catalog item | location | no | Integer | ||||||||||||||
location | no | Integer | Lists
| Recid of Location | |||||||||||||||||
owner | no* | IntegerLists | Lists
| Record ID of either the Contact or the Department ownerOwner | |||||||||||||||||
owner_type | no* | String | "contact" or "department" | Type of ownerOwner. | |||||||||||||||||
serial_number | no | String | Serial number of equipmentEquipment | ||||||||||||||||||
serial_number_barcode | no | String | Serial number barcode of equipmentEquipment | ||||||||||||||||||
equipment_id | no | String | ID of equipmentEquipment | ||||||||||||||||||
asset_tag | no | String | Asset tag of the equipmentEquipment | ||||||||||||||||||
billable | yes | Integer | 1 = yes; 0 = no | Designate if the equipment Equipment is billableBillable | |||||||||||||||||
consumed | yes | Integer | 1 = yes; 0 = no | Designate if the equipment Equipment is consumed | |||||||||||||||||
purchase_price | no | Decimal | Purchase price of the equipmentEquipment | ||||||||||||||||||
received_date | no | String | Date equipment Equipment was received | ||||||||||||||||||
billed_date | no | String | Date equipment Equipment was billed | ||||||||||||||||||
card_number | no | String | Card number of equipmentEquipment | ||||||||||||||||||
parent_equipment | no | IntegerLists | Lists
| Recid of parent equipmentEquipment, if applicable | |||||||||||||||||
cabling_equipment_type | no | Integer | Liststype | no | Integer | Lists
| Recid of Cabling Equipment type | ||||||||||||||
ip4_gateway | no | String | IPv4 address of gateway for equipmentEquipment | ||||||||||||||||||
ip6_gateway | no | String | IPv6 address of gateway for equipmentEquipment | ||||||||||||||||||
lan_name | no | String | Name of LAN equipment Equipment is attached to | ||||||||||||||||||
mac | no | String | MAC address of equipmentEquipment | ||||||||||||||||||
ip4 | no | String | IPv4 address of equipmentEquipment | ||||||||||||||||||
ip6 | no | String | IPv6 address of equipmentEquipment | ||||||||||||||||||
ip4_subnet | no | String | IPv4 address for subnet that equipment Equipment is attached to | ||||||||||||||||||
ip6_subnet | no | String | IPv6 address for subnet that equipment Equipment is attached to | ||||||||||||||||||
ip4_gateway_address | no | String | IPv4 address of gateway | ||||||||||||||||||
ip6_gateway_address | no | String | IPv6 address of gateway | ||||||||||||||||||
host_name | no | String | Host name of equipmentEquipment | ||||||||||||||||||
condition | no | IntegerLists | Lists
| Recid of condition value for equipmentEquipment. | |||||||||||||||||
ordered_date | no | String | Date equipment Equipment was ordered | ||||||||||||||||||
units | no | Quantity on hand | |||||||||||||||||||
warranty_end_date | no | String | Date that warranty ends on equipmentEquipment | ||||||||||||||||||
use_dhcp | yes | Integer | 1 = yes; 0 = no | Designate if the equipment Equipment uses DHCP | |||||||||||||||||
private | yes | Integer | 1 = yes; 0 = no | Designate if this equipment Equipment is private | |||||||||||||||||
vlan | no | Mixed | Recid of VLAN this Equipment belongs to. Multiple Recids can be provided using commas. Example: 23,34 | ||||||||||||||||||
contact | no | Integer | Recid of the contact(s) to associate this Equipment with | ||||||||||||||||||
remarks | no | String | Remarks for the Equipment | ||||||||||||||||||
gla | no | IntegerLists | 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 Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is required Conditionally Required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100. | gla_type | no* | Integer | ||||||||||||||
gla_type | no* | Integer | Lists
| Recid(s) of Expense Type(s). |
...
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
Results
If the request is successful, the equipment RECID will be returns as follows
...
:
Toggle cloak |
---|
Cloak |
---|
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=VLANS&field1=value1 ... |
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
equipment_recid
...
yes
...
Integer
...
Recid of equipment
...
vlan
...
yes
...
String
...
One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43
...
... |
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment | ||
vlan | yes | String | One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43 |
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 908 |
vlan | 1 |
Results
If the request is successful, the Recid(s) will be returned in the same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Cloak | |
---|---|
|
Equipment Remarks
Remarks can be added to Equipment.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment | ||
remarks | yes | String | The remark to add to the Equipment |
...
to add to the Equipment |
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 456231 |
remarks | This is a Remark from the API |
Results
If the request is successful, the Recid of the remark record will be returned as follows:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Cloak | |
---|---|
Equipment Charges
Charges can be easily added to Equipment. If multiple charges Charges need to be added to Equipment, 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 an Equipment charge Charge record.
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=CHARGES&field1=value1 ... |
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recid | Conditionallyno* | Integer | *Conditionally Required if attempting to UPDATE an Equipment Charge | ||||||||||||||
equipment_recid | yes | Integer | The RECID of the Equipment that the charge Charge is for | ||||||||||||||
charge_recid | yes | IntegerLists | Lists
| RECID of the applicable charge catalogCharge Catalog. | |||||||||||||
description | no | String | The details or description Description of the charge Charge on the Equipment | ||||||||||||||
amount | no* | FloatDecimal | The amount to be charged. *Conditionally Required if charge does not have an amount on it. | ||||||||||||||
quantity | no | Integer | 1 | Quantity of charge Charge to be used. | |||||||||||||
prorate | no | Integer | 1 or 0 | 0 | Should the charge Charge be prorated when activated | ||||||||||||
bill_date | no | String | Date the charge Charge was billed | ||||||||||||||
override_amount | noFloat | Decimal | If allowed by the selected chargeCharge, overrides the default amount from the charge. | override_gla | no | Integer | ListsCharge. | ||||||||||
override_gla | no | Integer | Lists
| Recid of GLA to override default GLA with. | |||||||||||||
stop_date | no | String | The Date the Recuring Recurring Charge should stop on. YYYY-MM-DD format. | ||||||||||||||
effective | no | String | today, backdate | today | Effective flag for the charge Charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API |
...
the API |
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 58337 |
charge_recid | 1 |
Results
If the request is successful, the RECID of the new Equipment charge is returned as follows:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment GLA
GLAs can be easily added to Equipment. If multiple charges need to be added to Equipment, then separate each value with commas.
Below is the proper format for making a separate request. Note "TYPE=GLA" to indicate that this is to add an Equipment GLA record(s).
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=GLA&field1=value1 ... |
If multiple GLAs are to be set, structure your request as follows:
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=GLA&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
equipment_recid
...
yes
...
Integer
...
The RECID of the Equipment that the charge 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
...
String
...
...
The type(s) of GLA(s).
...
|
Equipment GLA
GLAs can be easily added to Equipment. If multiple Charges need to be added to Equipment, then separate each value with commas.
Below is the proper format for making a separate request. Note "TYPE=GLA" to indicate that this is to add an Equipment GLA record(s).
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=GLA&field1=value1 ... |
If multiple GLAs are to be set, structure your request as follows:
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=GLA&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.
Available Fields
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | ||||||||||||||
gla | yes | String | 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 | Lists
| The type(s) of GLA(s). |
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
Results
If the request is successful, the RECID(s) of the new Equipment GLA records will be returned in same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
|
Equipment Contacts
Contacts can be easily added to Equipment. If multiple charges need to be added to Equipment, then separate each value with commas.
Below is the proper format for making a separate request. Note "TYPE=CONTACTS" to indicate that this is to add contacts to Equipment.
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=CONTACTS&field1=value1 ... |
Available Fields
Field | Required | Data Type | Options | Default | Notes | |
---|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | |||
contact | yes | String | Lists
|
...
Equipment Contacts
Contacts can be easily added to Equipment. If multiple charges need to be added to Equipment, then separate each value with commas.
Below is the proper format for making a separate request. Note "TYPE=CONTACTS" to indicate that this is to add contacts to Equipment.
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=CONTACTS&field1=value1 ... |
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
equipment_recid
...
yes
...
Integer
...
The RECID of the Equipment that the charge is for
...
contact
...
yes
...
String
...
...
Record ID(s) of the contact(s).
...
| Record ID(s) of the Contact(s). |
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
contact | 1 |
Results
If the request is successful, the RECID(s) of the new Equipment contact records will be returned in the same order provided:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
...
Cloak |
---|
Equipment UDFs
User Defined Fields can be easily set for Equipment. To get a list of available UDFs for a piece of equipment, visit Lists
Below is the proper format for making a UDF request. Note "TYPE=UDFS" to indicate that this is to add UDFs to Equipment.
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=UDFS&field1=value1 ... |
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
equipment_recid
...
yes
...
Integer
...
The RECID of the Equipment that the charge is for
...
udf_UDF-RECID
...
yes
...
Mixed
...
UDF-RECID is the RECID of the UDF to assign the value to. example: udf_684=value
...
Cloak | |
---|---|
|
Equipment UDFs
User Defined Fields can be easily set for Equipment. To get a list of available UDFs for a piece of Equipment, visit Lists.
Below is the proper format for making a UDF request. Note "TYPE=UDFS" to indicate that this is to add UDFs to Equipment.
Code Block |
---|
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=UDFS&field1=value1 ... |
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | Yes | Integer | The RECID of the Equipment that the Charge is for | ||
udf_UDF-RECID | Yes* | Integer | UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value
| ||
udf_UDF-IDENTIFIER | Yes* | Mixed | IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value
|
- udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 765 |
udf_UDF-RECID | 1 |
Results
If the request is successful, the RECID(s) of the new Equipment UDF records will be returned same order provided:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
...
Within PCR-360, these menu options lists list a variety of Grids that can be used to help locate any of the required fields.
- Main > Cable
- Main > Services
- Main > Inventory
- Main > Catalog
- Specifically: Services, Equipment, Charges and G/L Accounts (GLA)
...