Table of Contents | ||||
---|---|---|---|---|
|
...
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
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.
These parameters are added in addition to any fields from the specific data types.
Parameter | Default | Description |
---|---|---|
limitLIMIT | 20 | Number of listings to show. Maximum is 50. |
pagePAGE | 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 Equipment item is or is not Billable. |
EQUIPMENT_ID | string | Yes | Unique identifier of a piece of Equipment; this is required for data Equipment. |
ASSET_TAG | string | Yes | Unique identifier of a piece of Equipment; this is required for Assets. |
SERIAL_NUM | string | Yes | A unique identifier for one individual instance of a piece of Equipment; often supplied by the manufacturer. |
PURCHASE_PRICE / | number | Yes | The price paid upon purchase of the Equipment. 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 was received. |
BILLED_DATE | string | Yes | Date the piece of Equipment was billed. |
CATALOG | string | Yes | Equipment part number. |
OWNER | string | Yes | The Contact or Dept Hierarchy that owns this piece of Equipment. |
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 of the piece of Equipment; use LOCATIONS for search. |
EQP_STATUS | string | Yes | Current status of the piece of Equipment. Use STATUS for search. |
EQUIPMENT_UDF | list | No | List of all the User Defined Fields and the selected values for this piece of Equipment. |
EQUIPMENT_CHARGES | list | No | Charges listed for the piece of Equipment. |
EQUIPMENT_CONTACTS | list | No | Contacts associated with the piece of Equipment. |
EQUIPMENT_EXPENSE_GLA | list | No | Expense G/L Accounts to be used for billing for the piece of Equipment. |
EQUIPMENT_REMARKS | list | No | List of all remarks/comments for the piece of Equipment. |
...
Field | Required | Data Type | Options | Default | Notes | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RECID | no* | Integer | Identifier of the record to be updated | |||||||||||||||||
status | yes | Integer | The status of the Equipment | |||||||||||||||||
eqp_catalog | yes | Integer | Recid of the Equipment Catalog item | |||||||||||||||||
location | no | Integer Lists | Lists
| Recid of Location | ||||||||||||||||
owner | no* | Integer | Record ID of either the Contact or the Department Owner | |||||||||||||||||
owner_type | no* | String | "contact" or "department" | Type of Owner. | ||||||||||||||||
serial_number | no | String | Serial number of Equipment | |||||||||||||||||
serial_number_barcode | no | String | Serial number barcode of Equipment | |||||||||||||||||
equipment_id | no | String | ID of Equipment | |||||||||||||||||
asset_tag | no | String | Asset tag of the Equipment | |||||||||||||||||
billable | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is Billable | ||||||||||||||||
consumed | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is consumed | ||||||||||||||||
purchase_price | no | Decimal | Purchase price of the Equipment | |||||||||||||||||
received_date | no | String | Date Equipment was received | |||||||||||||||||
billed_date | no | String | Date Equipment was billed | |||||||||||||||||
card_number | no | String | Card number of Equipment | |||||||||||||||||
parent_equipment | no | Integer | Recid of parent Equipment, if applicable | |||||||||||||||||
cabling_equipment_type | no | Integer | Recid of Cabling Equipment type | |||||||||||||||||
ip4_gateway | no | String | IPv4 address of gateway for Equipment | |||||||||||||||||
ip6_gateway | no | String | IPv6 address of gateway for Equipment | |||||||||||||||||
lan_name | no | String | Name of LAN Equipment is attached to | |||||||||||||||||
mac | no | String | MAC address of Equipment | |||||||||||||||||
ip4 | no | String | IPv4 address of Equipment | |||||||||||||||||
ip6 | no | String | IPv6 address of Equipment | |||||||||||||||||
ip4_subnet | no | String | IPv4 address for subnet that Equipment is attached to | |||||||||||||||||
ip6_subnet | no | String | IPv6 address for subnet that 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 Equipment | |||||||||||||||||
condition | no | Integer | Recid of condition value for Equipment. | |||||||||||||||||
ordered_date | no | String | Date Equipment was ordered | |||||||||||||||||
units | no | Quantity on hand | ||||||||||||||||||
warranty_end_date | no | String | Date that warranty ends on Equipment | |||||||||||||||||
use_dhcp | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment uses DHCP | ||||||||||||||||
private | yes | Integer | 1 = yes; 0 = no | Designate if this 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 | Integer | 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 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 | cloak | no* | Integer | Lists
| Recid(s) of Expense Type(s). |
...
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 |
...
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 |
...
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 |
...
Field | Required | Data Type | Options | Default | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recid | no* | Integer | *Conditionally Required if attempting to UPDATE an Equipment Charge | |||||||||||||||
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | |||||||||||||||
charge_recid | yes | Integer | 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. *Conditionally Required if charge does not have an amount on it. | |||||||||||||||
quantity | no | Integer | 1 | Quantity of Charge to be used. | ||||||||||||||
prorate | no | Integer | 1 or 0 | 0 | Should the Charge be prorated when activated | |||||||||||||
bill_date | no | String | Date the Charge was billed | |||||||||||||||
override_amount | no | Decimal | If allowed by the selected Charge, overrides the default amount from the Charge. | |||||||||||||||
override_gla | no | Integer Cloak | | Lists
| Recid of GLA to override default GLA with. | |||||||||||||
stop_date | no | String | The Date the Recurring Charge should stop on. YYYY-MM-DD format. | |||||||||||||||
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 |
...
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 |
...
Field | Required | Data Type | Options | Default | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for | |||||||||||||||
gla | yes | String cloak | 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 Cloak | | Lists
| The type(s) of GLA(s). |
Request Example
...
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 |
...
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). |
...
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 |
...
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 |
...
Within PCR-360, these menu options 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)
...