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
...
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
Insert excerpt SQL API Calls SQL API Calls nopanel true
Available Fields
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RECID | no* | Integer | Identifier of the record to be updated | ||||||||||||||
status | yes | Integer | Lists
| The status of the Equipment | |||||||||||||
eqp_catalog | yes | Integer | Lists
| Recid of the Equipment Catalog item | |||||||||||||
location | no | Integer | Lists
| Recid of Location | |||||||||||||
owner | no* | Integer | Lists
| 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 | Lists
| Recid of parent Equipment, if applicable | |||||||||||||
cabling_equipment_type | no | Integer | Lists
| 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 | Lists
| 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 | 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 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 | 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 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | IntegerRecid of equipment. | RECID column from EQUIPMENT _VLANS table. | ||
vlan | yes | String | One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43 |
...
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 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment. RECID column from EQUIPMENT _REMARKS table. | ||
remarks | yes | String | The remark to add to the Equipment |
...
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. RECID column from EQUIPMENT_CHARGES table. | ||||||||||||||
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for. | ||||||||||||||
charge_recid | yes | Integer | Lists
| 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 | ||||||||||||
start_date | yesno | 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 | MCR 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 | |||||||||||||
override_amount | no | Decimal | If allowed by the selected Charge, overrides the default amount from the Charge. | ||||||||||||||
override_gla | no | Integer | Lists
| RECID of GLA to override default GLA with. | |||||||||||||
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. |
...
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. RECID column from EQUIPMENT _EXPENSE_GLA table. | ||||||||||||||
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). |
...
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. RECID column from EQUIPMENT _CONTACTS table. | ||||||||||||||
contact | yes | String | Lists
| 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 |
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | Yes | Integer | The RECID of the Equipment that the Charge is for. RECID column from USER_DEFINED_FIELDS_VALS column from EQUIPMENT table. | ||
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
|
...
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)
...