| 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.Retrieving_Data&action=edit&redlink=1 Making a Request
Controlling Results Count
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>20</count>
<total_count>3174</total_count>
<equipment>
<item>
<RECID>124</RECID>
<MODIFIED_DATE>2015-02-11 16:04:26</MODIFIED_DATE>
<BILLABLE>Yes</BILLABLE>
<EQUIPMENT_ID>db 123358681</EQUIPMENT_ID>
<ASSET_TAG/><SERIAL_NUM/>
<PURCHASE_PRICE>100</PURCHASE_PRICE>
<CONSUMED>No</CONSUMED>
<RECEIVED_DATE>2012-12-04 00:00:00</RECEIVED_DATE>
<BILLED_DATE/>
<CAT_RECID>36</CAT_RECID>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<CATALOG>100</CATALOG>
<OWNER>Doe, John</OWNER>
<DEPT_HIERARCHY_PATH/>
<LOCATIONS_PATH>Main > Warehouse 1</LOCATIONS_PATH>
<E_EQP_STATUS_VALUE>Assigned</E_EQP_STATUS_VALUE>
<EQP_STATUS>ASSIGNED</EQP_STATUS>
<E_CABLING_EQP_TYPE_VALUE/>
<CABLING_EQP_TYPE/>
<E_EQP_CONDITION_VALUE>New</E_EQP_CONDITION_VALUE>
<EQP_CONDITION>NEW</EQP_CONDITION>
<EQUIPMENT_UDF>
<item>
<LABEL>OS Installed</LABEL>
<VALUE>Redhat</VALUE>
</item>
</EQUIPMENT_UDF>
<EQUIPMENT_CHARGES>
<item>
<RECID>171</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2014-08-22 11:33:17</MODIFIED_DATE>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<EQUIPMENT_RECID>51</EQUIPMENT_RECID>
<CHRG_CATALOG_RECID>71</CHRG_CATALOG_RECID>
<DESCRIPTION/>
<AMOUNT>21.99</AMOUNT>
<BILLED_DATE/>
<PRORATE>0</PRORATE>
<EXPENSE_GLA_RECID/>
<QUANTITY/>
<CATALOG_NAME>Analog Charge</CATALOG_NAME>
<CATALOG_DESCRIPTION>Charge for Analog service</CATALOG_DESCRIPTION>
<CATALOG_AMOUNT>21.99</CATALOG_AMOUNT>
</item>
</EQUIPMENT_CHARGES>
<EQUIPMENT_CONTACTS>
<item>
<RECID>1916</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2014-07-22 10:24:43</MODIFIED_DATE>
<MODIFIED_BY>PCR USer</MODIFIED_BY>
<EQUIPMENT_RECID>124</EQUIPMENT_RECID>
<CONTACTS_RECID>56</CONTACTS_RECID>
<FIRST_NAME>John</FIRST_NAME>
<LAST_NAME>Doe</LAST_NAME>
<DEPT_HIERARCHY_PATH/>
</item>
</EQUIPMENT_CONTACTS>
<EQUIPMENT_EXPENSE_GLA>
<item>
<PERCENT>100</PERCENT>
<Type>Default</Type>
<GLA_FULL_CODES_0>100 > 200 > 00 > 687</GLA_FULL_CODES_0>
<GLA_FULL_CODES_1/>
<GLA_FULL_CODES_2/>
</item>
</EQUIPMENT_EXPENSE_GLA>
<EQUIPMENT_REMARKS/>
</item>
</equipment> |
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.
...
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 | |
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 |
Contacts Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<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>
</equipment> |
Department Hierarchy Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<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>
</equipment> |
Equipment Catalog Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>64</count>
<total_count>64</total_count>
<eqp_catalog>
<item>
<RECID>56</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2013-08-20 13:56:56</MODIFIED_DATE>
<MODIFIED_BY>LOrgana</MODIFIED_BY>
<STATUS>1</STATUS>
<PART_NUMBER>Test 1</PART_NUMBER>
<PART_NUM_BARCODE>2939473020239</PART_NUM_BARCODE>
<DESCRIPTION>Blaster</DESCRIPTION>
<MANUFACTURER>Integrated Galactic Blaster Corp.</MANUFACTURER
<MANU_PART_NUM>T23</MANU_PART_NUM>
<CATALOG_DESCRIPTION>The last line of defense that you will ever need.</CATALOG_DESCRIPTION>
<CATEGORY>0</CATEGORY>
<PRORATE>0</PRORATE>
<ASSIGNABLE>1</ASSIGNABLE>
<BILLABLE>0</BILLABLE>
<CABLING_EQUIPMENT>1</CABLING_EQUIPMENT>
<ASSET>0</ASSET>
<LOCATION_REQUIRED>0</LOCATION_REQUIRED>
<ORDERABLE>1</ORDERABLE>
<CONSUMABLE>0</CONSUMABLE>
<PROVISIONED>0</PROVISIONED>
<REVENUE_GLA_RECID>42</REVENUE_GLA_RECID>
<REVENUE_OB_CODES_RECID>6</REVENUE_OB_CODES_RECID>
<EXPENSE_OB_CODES_RECID>6</EXPENSE_OB_CODES_RECID>
<WORKER_INSTALL_TIME/>
<WORKER_REMOVE_TIME/>
<MAX_QUANTITY/>
<PARENT_EQP_CATALOG_RECID>28</PARENT_EQP_CATALOG_RECID>
<WARRANTY_LENGTH_LISTS_RECID/>
<HEIGHT/>
<WIDTH/>
<SLOTS/>
<UNIT_LISTS_RECID>1339</UNIT_LISTS_RECID>
<HAS_UNITS>0</HAS_UNITS>
<CONTIGUOUS>0</CONTIGUOUS>
<CM_MODEL/>
<BILLING_GROUP_RESTRICT/>
<LOCATION_RESTRICT>
<item>111</item>
</LOCATION_RESTRICT>
</item>
</eqp_catalog>
</equipment> |
Expense Types Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<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>
</equipment> |
GLAs Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<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>
</equipment> |
Locations Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<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>
</equipment> |
UDF Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>20</count>
<total_count>20</total_count>
<udfs>
<item>
<UDF_RECID>10</UDF_RECID>
<LABEL>test</LABEL>
<FIELD_TYPE>Text</FIELD_TYPE>
<REQUIRED>0</REQUIRED>
<DESCRIPTION>A UDF Field</DESCRIPTION>
<UDF_ORDER>1</UDF_ORDER>
<FORM_ELEMENT_WIDTH/>
<FORM_ELEMENT_HEIGHT/>
<FORM_ELEMENT_TEXT_WIDTH/>
<SD_TYPE>Service Request</SD_TYPE>
<VERIFY>0</VERIFY>
<AGING_PERSISTENT>0</AGING_PERSISTENT>
<UDTABLE_DEF/>
<TYPES/>
</item>
</udfs>
</equipment> |
Cabling Equipment Types Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<cabling_eqp_type>
<item>
<RECID>2126</RECID>
<VALUE>Jack</VALUE>
</item>
</cabling_eqp_type>
</equipment> |
Equipment Conditions Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<eqp_condition>
<item>
<RECID>1180</RECID>
<VALUE>Used</VALUE>
</item>
</eqp_condition>
</equipment> |
Equipment Statuses Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<eqp_status>
<item>
<RECID>1541</RECID>
<VALUE>Pending</VALUE>
</item>
</eqp_status>
</equipment> |
VLANs Results
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<equipment>
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<vlans>
<item>
<RECID>24</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2013-06-06 09:41:45</MODIFIED_DATE>
<MODIFIED_BY>lskywalker</MODIFIED_BY>
<VLAN>505</VLAN>
<DESCRIPTION>VLAN 505: Galactic Connection</DESCRIPTION>
<GATEWAY/>
<NETMASK/>
</item>
</vlans>
</equipment> |
...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
RECID | only when updating | 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 | 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 required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100. | |
gla_type | no* | Integer | Recid(s) of Expense Type(s). *Required if GLA is specified |
...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the charge is for | ||
charge_recid | yes | Integer | Record ID of the applicable charge. | ||
description | no | String | The details or description of the charge on the Equipment | ||
amount | no* | Float | The amount to be charged. *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 | Float | If allowed by the selected charge, overrides the default amount from the charge. | ||
override_gla | no | Integer | Recid of GLA to override default GLA with. |
...
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). |
Results
...
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). |
...
Within PCR-360, these menu options lists 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)