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 Equipment and related records:

Code Block

language	sql

SELECT * FROM EQUIPMENT;

...

Request Type

...

Description

...

equipment.OUTPUT

...

Retrieve equipment that match your search.

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

...

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 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 /
PURCHASE_PRICE_GREATER /
PURCHASE_PRICE_LESS

...

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.

...

language	php
linenumbers	true

...

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 Equipment and related records:

Code Block

language	sql

SELECT * FROM EQUIPMENT;

Request Type	Description
equipment.OUTPUT	Retrieve equipment that match your search.

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
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 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 / PURCHASE_PRICE_GREATER / PURCHASE_PRICE_LESS	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.

Results

...

Code Block

language	php
linenumbers	true

    <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/>

<status>success</status>

<PURCHASE_PRICE>100</PURCHASE_PRICE>

    <CONSUMED>No</CONSUMED>

<total_count>3174</total_count>

<RECEIVED_DATE>2012-12-04 00:00:00</RECEIVED_DATE>

    <BILLED_DATE/>

<item>

<RECID>124</

<CAT_RECID>36</CAT_RECID>
            <MODIFIED_

DATE>2015-02-11 16:04:26<

BY>PCR User</MODIFIED_

DATE>

BY>

<BILLABLE>Yes<

<CATALOG>100</

BILLABLE>

CATALOG>

<EQUIPMENT_ID>db 123358681</EQUIPMENT_ID>

<OWNER>Doe, John</OWNER>

<ASSET

<DEPT_

TAG/><SERIAL

HIERARCHY_

NUM

PATH/>

<PURCHASE_PRICE>100</PURCHASE_PRICE>

<LOCATIONS_PATH>Main > Warehouse 1</LOCATIONS_PATH>

<E_EQP_STATUS_VALUE>Assigned</E_EQP_STATUS_VALUE>

<RECEIVED_DATE>2012-12-04 00:00:00</RECEIVED_DATE>

<EQP_STATUS>ASSIGNED</EQP_STATUS>

<BILLED_DATE

<E_CABLING_EQP_TYPE_VALUE/>

<CAT

<CABLING_EQP_

RECID>36<

TYPE/

CAT_RECID>

<MODIFIED_BY>PCR User</MODIFIED_BY>

<E_EQP_CONDITION_VALUE>New</E_EQP_CONDITION_VALUE>

<EQP_CONDITION>NEW</EQP_CONDITION>

<EQUIPMENT_UDF>

<DEPT_HIERARCHY_PATH/>

  <item>

<LOCATIONS_PATH>Main

>

Warehouse

1</LOCATIONS_PATH>

<E_EQP_STATUS_VALUE>Assigned</E_EQP_STATUS_VALUE>

<LABEL>OS Installed</LABEL>

<EQP_STATUS>ASSIGNED</EQP_STATUS>

        <VALUE>Redhat</VALUE>

<E_CABLING_EQP_TYPE_VALUE/>

<CABLING_EQP_TYPE/>

</item>

<E_EQP_CONDITION_VALUE>New</E_EQP_CONDITION_VALUE>

</EQUIPMENT_UDF>

<EQP_CONDITION>NEW</EQP_CONDITION>

<EQUIPMENT_CHARGES>

<EQUIPMENT_UDF>

   <item>

<item>

       <RECID>171</RECID>

<LABEL>OS

Installed</LABEL>

      <TENANTS_RECID>0</TENANTS_RECID>

<VALUE>Redhat</VALUE>

      <MODIFIED_DATE>2014-08-22 11:33:17</MODIFIED_DATE>

</item>

           <MODIFIED_BY>PCR

<

User</

EQUIPMENT

MODIFIED_

UDF>

BY>

<EQUIPMENT_CHARGES>

        <EQUIPMENT_RECID>51</EQUIPMENT_RECID>

<item>

<RECID>171</

<CHRG_CATALOG_RECID>71</CHRG_CATALOG_RECID>

<TENANTS_RECID>0</TENANTS_RECID>

<DESCRIPTION/>

<MODIFIED_DATE>2014-08-22 11:33:17</MODIFIED_DATE>

<AMOUNT>21.99</AMOUNT>

<MODIFIED

<BILLED_

BY>PCR User</MODIFIED_BY>

DATE/>

<EQUIPMENT_RECID>51</EQUIPMENT_RECID>

<PRORATE>0</PRORATE>

<CHRG

<EXPENSE_

CATALOG

GLA_

RECID>71</CHRG_CATALOG_RECID>

RECID/>

<DESCRIPTION

<QUANTITY/>

 <CATALOG_NAME>Analog Charge</CATALOG_NAME>

<BILLED

<CATALOG_

DATE/>

DESCRIPTION>Charge for Analog service</CATALOG_DESCRIPTION>

   <CATALOG_AMOUNT>21.99</CATALOG_AMOUNT>

<EXPENSE_GLA_RECID/>

</item>
            </EQUIPMENT_CHARGES>

     <EQUIPMENT_CONTACTS>

<CATALOG_NAME>Analog Charge</CATALOG_NAME>

 <item>

<CATALOG_DESCRIPTION>Charge for Analog service</CATALOG_DESCRIPTION>

<RECID>1916</RECID>

<CATALOG

<TENANTS_

AMOUNT>21.99<

RECID>0</

CATALOG_AMOUNT>

TENANTS_RECID>

</item>

<MODIFIED_DATE>2014-07-22 10:24:43</MODIFIED_DATE>

</EQUIPMENT_CHARGES>

        <MODIFIED_BY>PCR USer</MODIFIED_BY>

<EQUIPMENT_CONTACTS>

<item>

<EQUIPMENT_RECID>124</EQUIPMENT_RECID>

<RECID>1916<

<CONTACTS_RECID>56</CONTACTS_RECID>

<TENANTS

<FIRST_

RECID>0<

NAME>John</

TENANTS

FIRST_

RECID>

NAME>

<MODIFIED_DATE>2014-07-22 10:24:43</MODIFIED_DATE>

<LAST_NAME>Doe</LAST_NAME>

<MODIFIED_BY>PCR USer</MODIFIED_BY>

<DEPT_HIERARCHY_PATH/>
                </item>

<EQUIPMENT_RECID>124</EQUIPMENT_RECID>

         </EQUIPMENT_CONTACTS>

<CONTACTS

<EQUIPMENT_

RECID>56</CONTACTS_RECID>

EXPENSE_GLA>
                <item>

<FIRST_NAME>John</FIRST_NAME>

                <PERCENT>100</PERCENT>

<LAST_NAME>Doe</LAST_NAME>

                <Type>Default</Type>

<DEPT_HIERARCHY_PATH/>

</item>

<GLA_FULL_CODES_0>100 > 200 > 00 > 687</GLA_FULL_CODES_0>

</EQUIPMENT_CONTACTS>

<EQUIPMENT

<GLA_FULL_

EXPENSE

CODES_

GLA>

1/>

<item>

    <GLA_FULL_CODES_2/>

<PERCENT>100<

</

PERCENT>

item>

<Type>Default</Type> <GLA_FULL_CODES_0>100 > 200 > 00 > 687</GLA_FULL_CODES_0>

</EQUIPMENT_EXPENSE_GLA>

<GLA_FULL_CODES_1

<EQUIPMENT_REMARKS/>
        </item>

<GLA_FULL_CODES_2/> </item> </EQUIPMENT_EXPENSE_GLA> <EQUIPMENT_REMARKS/> </item> </equipment>

...

</equipment>

Lists
Anchor
lists
lists

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.

...

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

DEPTHIER

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	php
linenumbers	true

Retrieve available Departments

Coming Soon

Results

EQP_CATALOG

Retrieve available Equipment Catalogs

yes

Results

EXPENSE_TYPE

Retrieve available Expense Types

no

Results

GLAS

Retrieve available GLAs

no

Results

LOCATIONS

Retrieve available Locations

yes

Results

UDFS

Retrieve available User Defined Fields (UDF)

eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53"

no

Results

CABLING_EQP_TYPE

Retrieve available Cabling Equipment Types

no

Results

EQP_CONDITION

Retrieve available Equipment Conditions

no

Results

EQP_STATUS

Retrieve available Equipment Statuses

no

Results

VLANS

Retrieve available VLANs

no

Results

Contacts Results
Anchor
contacts
contacts

Code Block

language	php
linenumbers	true

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

...

DEPTHIER

...

Retrieve available Departments

...

Coming Soon

...

language	php
linenumbers	true

<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
depthierarchy
depthierarchy

Code Block

language	php
linenumbers	true

    <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/>

...

EQP_CATALOG

...

Retrieve available Equipment Catalogs

...

yes

...

language	php
linenumbers	true

...

 <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
equipment
equipment

Code Block

language	php
linenumbers	true

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

...

EXPENSE_TYPE

...

Retrieve available Expense Types

...

no

...

language	php
linenumbers	true

...

<CM_MODEL/>

...

<BILLING_GROUP_RESTRICT/>

...

<LOCATION_

...

RESTRICT>

...

<item>111</item>

...

</

...

LOCATION_RESTRICT>
            </item>
        </

...

eqp_

...

catalog>
    </equipment>

...

GLAS

...

Retrieve available GLAs

...

no

...

Expense Types Results
Anchor
expense
expense

Code Block

language	php
linenumbers	true

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

...

LOCATIONS

...

Retrieve available Locations

...

yes

...

GLAs Results
Anchor
gla
gla

Code Block

language	php
linenumbers	true

    <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
locations
locations

Code Block

language	php
linenumbers	true

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

...

UDFS

...

Retrieve available User Defined Fields (UDF)

...

eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53"

...

no

...

language	php
linenumbers	true

...

  <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
udf
udf

Code Block

language	php
linenumbers	true

    <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/>

...

CABLING_EQP_TYPE

...

Retrieve available Cabling Equipment Types

...

no

...

language	php
linenumbers	true

...

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

...

EQP_CONDITION

...

Retrieve available Equipment Conditions

...

no

...

Cabling Equipment Types Results
Anchor
cabling
cabling

Code Block

language	php
linenumbers	true

    <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

...

conditions
conditions

Code Block

language	php
linenumbers	true

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

...

VLANS

...

Retrieve available VLANs

...

no

...

Equipment Statuses Results
Anchor
status
status

Code Block

language	php
linenumbers	true

    <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
vlan
vlan

Code Block

language	php
linenumbers	true

    <equipment>

...

<status>success</status>
        <page>1</page>

...

<count>1</

...

count>
        <total_count>1</total_count>

...

<vlans>

...

           <item>

...

<RECID>24</RECID>

...

Write Call

Available Fields

...

Field

...

Required

...

Data Type

...

Options

...

Default

...

Notes

...

RECID

...

no*

...

Integer

...

Identifier of the record to be updated
*Conditionally Required for updating

...

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
*Conditionally Required for updating

...

owner_type

...

no*

...

String

...

"contact" or "department"

...

Type of Owner.
*Conditionally Required only when setting an 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

...

Recid(s) of Expense Type(s).
*Conditionally Required if GLA is specified

Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

...

Key

...

Value

...

status

...

Active

...

eqp_catalog

...

1

...

Results

...

         <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-06-06 09:41:45</MODIFIED_DATE>
                <MODIFIED_BY>lskywalker</MODIFIED_BY>
                <VLAN>505</VLAN>

<status>success</status>

      <DESCRIPTION>VLAN 505: Galactic

Connection</DESCRIPTION>

<GATEWAY/>

<total_count>0</total_count>

<NETMASK/>

</

equipment>

Image Removed

Cloak

Code Block

language	php
linenumbers	true

Equipment VLANs

Equipment can be assigned to one or more VLANs.

Below is the proper format for making a separate request. Note "TYPE=VLANS" to indicate that this is to add Equipment to VLANs.

POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=VLANS&field1=value1 ...item>
        </vlans>
    </equipment>

Write Call

Available Fields

Request Example

Call:

Code Block

language	php

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
Field	Required	Data Type	Options	Default	Notes
RECID	only when updating	Integer			Identifier of the record to be updated
status	yes	Integer	Lists	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

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

...

Key

...

Value

...

status

...

Active

...

eqp_catalog

...

1

...

908

...

Results

...

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>
            <item>908</item>
            <item>909</item>
        </equipment>
    </equipment>

Image Removed

Equipment Remarks

Remarks can be added to Equipment.

Below is the proper format for making a separate request. Note "TYPE=REMARK" to indicate that this is to add a remark to Equipment.

Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=REMARK&field1=value1 ...

Available Fields

...

Field

...

Required

...

Data Type

...

Options

...

Default

...

Notes

...

equipment_recid

...

yes

...

Integer

...

Recid of equipment

...

remarks

...

yes

...

String

...

The remark to add to the Equipment

Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

...

Key

...

Value

...

status

...

Active

...

eqp_catalog

...

1

...

456231

...

Results

...

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>456231<equipment>
    </equipment>

Image Removed

Equipment Charges

Charges can be easily added to Equipment. If multiple 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 record.

Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=CHARGES&field1=value1 ...

Available Fields

...

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

...

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.

...

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.


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. *Required only when setting an 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 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). *Required if GLA is specified

Results

If the request is successful, the equipment RECID will be returns as follows:

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>46521</equipment>
    </equipment>

Equipment App Record

Image Added

Equipment VLANs

Equipment can be assigned to one or more VLANs.

Below is the proper format for making a separate request. Note "TYPE=VLANS" to indicate that this is to add Equipment to VLANs.

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

Results

If the request is successful, the Recid(s) will be returned in the same order provided:

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>
            <item>908</item>
            <item>909</item>
        </equipment>
    </equipment>

Equipment VLAN Tab App Record

Image Added

Equipment Remarks

Remarks can be added to Equipment.

Below is the proper format for making a separate request. Note "TYPE=REMARK" to indicate that this is to add a remark to Equipment.

Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=REMARK&field1=value1 ...

Available Fields

Field	Required	Data Type	Options	Default	Notes
equipment_recid	yes	Integer			Recid of equipment
remarks	yes	String			The remark to add to the Equipment

Results

If the request is successful, the RECID Recid of the new Equipment charge is remark record will be returned as follows: Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_

count>1<

count>0</total_count>

<equipment>456231<equipment>
    </equipment>

Equipment

...

Remarks Tab App Record

Image Added

Equipment Charges

Charges can be easily added to Equipment. If multiple Charges charges need to be added to Equipment, then separate each value with commasPOST requests will need to be made.

Below is the proper format for making a separate request. Note "TYPE=GLACHARGES" to indicate that this is to add create 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:

charge record.

Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=GLA&field1=v1.1,v1.2&field2=v2.1,v2.2TYPE=CHARGES&field1=value1 ...

When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.

Available Fields

Body:

Lists Lists

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	gla	yes	String
Toggle cloak
Cloak
Insert excerpt
API	API
nopanel	true
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
Toggle cloak
Cloak
Insert excerpt
API	API
nopanel	true
The type(s) of GLA(s).

Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

	Notes
equipment_recid	yes	Integer			The RECID of the Equipment that the charge is for
charge_recid	yes	Integer	Lists		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	Lists		Recid of GLA to override default GLA with.

Results

If the request is successful, the RECID (s) of the new Equipment GLA records will be returned in same order provided: Toggle cloak

...

charge is returned as follows:

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>

<equipment> <item>2345</item> <item>2346</item> </

<equipment>58337</equipment>
    </equipment>

Image Removed

Equipment

...

GLA

Contacts 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=CONTACTSGLA" to indicate that this is to add contacts to Equipment.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=CONTACTS&field1=value1 ..=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

Body:

Lists

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	contact	yes	String
Toggle cloak
Cloak
Insert excerpt
API	API
nopanel	true
Record ID(s) of the Contact(s).

Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

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).

Results

If the request is successful, the RECID(s) of the new Equipment contact GLA records will be returned in the same order provided: Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <equipment>

<item>1234<

<item>2345</item>

<item>1235<

<item>2346</item>
        </equipment>
    </equipment>

Equipment Form GLA Tab App Record

Image Modified

Equipment

...

Contacts

User Defined Fields Contacts can be easily set for Equipment. To get a list of available UDFs for a piece of Equipment, visit Listsadded 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 UDF separate request. Note "TYPE=UDFSCONTACTS" to indicate that this is to add UDFs contacts to Equipment.

Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=UDFSCONTACTS&field1=value1 ...

Available Fields

Field	Required	Data Type	Options	Default	Notes
equipment_recid	Yesyes	Integer			The RECID of the Equipment that the Charge 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 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.

Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/equipment.json

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Pcr-Html-Encoded

...

TRUE

Body:

1

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	765
udf_UDF-RECID
contact	yes	String	Lists	Record ID(s) of the contact(s).

Results

If the request is successful, the RECID(s) of the new Equipment contact records will be returned in same order provided:

Code Block

language	php
linenumbers	true

    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <equipment>
            <item>1234</item>
            <item>1235</item>
        </equipment>
    </equipment>

Equipment Form Contacts Tab App Record

Image Added

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

Results

If the request is successful, the RECID(s) of the new Equipment UDF records will be returned same order provided: Toggle cloak

...

Code Block
<equipment> <status>success</status> <page>1</page> <count>1</count> <total_count>1</total_count> <equipment> <item>765</item> <item>766</item> </equipment> </equipment>

Locating Equipment Data

Within PCR-360, these menu options list lists a variety of Grids that can be used to help locate any of the required fields.

...

Page Comparison

Versions Compared

Old Version 43

New Version 44

Key

Read Call

Controlling Results Count

Response Data

Read Call

Controlling Results Count

Response Data

Results

Lists Anchorlistslists

Contacts Results Anchorcontactscontacts

Department Hierarchy Results Anchordepthierarchydepthierarchy

Equipment Catalog Results Anchorequipmentequipment

Expense Types Results Anchorexpenseexpense

GLAs Results Anchorglagla

Locations Results Anchorlocationslocations

UDF Results Anchorudfudf

Cabling Equipment Types Results Anchorcablingcabling

Equipment

Conditions Results... Anchor

conditionsconditions

Equipment Statuses Results Anchorstatusstatus

VLANs Results Anchorvlanvlan

Write Call

Available Fields

Request Example

Call:

Headers:

Body:

Results

Equipment VLANs

Write Call

Available Fields

Request Example

Call:

Headers:

Body:

Request Example

Call:

Headers:

Body:

Results

Equipment Remarks

Available Fields

Request Example

Call:

Headers:

Body:

Results

Equipment Charges

Available Fields

Results

Equipment App Record

Equipment VLANs

Available Fields

Results

Equipment VLAN Tab App Record

Equipment Remarks

Available Fields

Results

Equipment

Remarks Tab App Record

Equipment Charges

Available Fields

Body:

Request Example

Call:

Headers:

Results

Equipment

GLA

Available Fields

Body:

Request Example

Call:

Headers:

Results

Lists
Anchor
lists
lists

Contacts Results
Anchor
contacts
contacts

Department Hierarchy Results
Anchor
depthierarchy
depthierarchy

Equipment Catalog Results
Anchor
equipment
equipment

Expense Types Results
Anchor
expense
expense

GLAs Results
Anchor
gla
gla

Locations Results
Anchor
locations
locations

UDF Results
Anchor
udf
udf

Cabling Equipment Types Results
Anchor
cabling
cabling

Conditions Results
...
Anchor

conditions
conditions

Equipment Statuses Results
Anchor
status
status

VLANs Results
Anchor
vlan
vlan