Versions Compared

Old Version 8

changes.mady.by.user Jeremiah Sokolowski

Saved on

compared with

New Version Current

changes.mady.by.user Bianca Rosa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

Table of Contents
outlinetrue
stylenone

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

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

...

Cloak


Code Block
languagephp
linenumberstrue
    <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/>           <CONTACTS_RECID>56</CONTACTS_RECID>
      </item>              <<FIRST_NAME>John</EQUIPMENTFIRST_CONTACTS>NAME>
            <EQUIPMENT_EXPENSE_GLA>        <LAST_NAME>Doe</LAST_NAME>
        <item>            <DEPT_HIERARCHY_PATH/>
        <PERCENT>100</PERCENT>        </item>
            <Type>Default<</Type>EQUIPMENT_CONTACTS>
            <EQUIPMENT_EXPENSE_GLA>
       <GLA_FULL_CODES_0>100 > 200 > 00 > 687</GLA_FULL_CODES_0>   <item>
                 <GLA_FULL_CODES_1/>    <PERCENT>100</PERCENT>
                <GLA_FULL_CODES_2/>    <Type>Default</Type>
            </item>        <GLA_FULL_CODES_0>100 > 200 > 00 > <687</EQUIPMENTGLA_FULL_EXPENSE_GLA>CODES_0>
                <EQUIPMENT_REMARKS/>    <GLA_FULL_CODES_1/>
    </item>     </equipment>

...

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

...

CONTACTS

...

Retrieve available Contacts

...

CTYPE - Type of contact. Example: "worker"

...

yes

...

Results

...

DEPTHIER

...

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

...

           <GLA_FULL_CODES_2/>
                </item>
            </EQUIPMENT_EXPENSE_GLA>
            <EQUIPMENT_REMARKS/>
        </item>
    </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.

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

Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>
...



...
DEPTHIER
Retrieve available Departments

Coming Soon
Department Hierarchy
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>
...



EQP_CATALOG
Retrieve available Equipment Catalogs

yes
Equipment Catalog
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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_TYPE
Retrieve available Expense Types
...
...

no
...
Expense Types
...
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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
Retrieve available GLAs
...
...

no
...
GLA
...
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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
Retrieve available Locations
...
...

yes
...
Locations
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>
...



UDFS
Retrieve available User Defined Fields (UDF)
eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53"
no
UDF
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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_EQP_TYPE
Retrieve available Cabling Equipment Types
...
...

no
Cabling Equipment Types
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>



EQP_CONDITION
Retrieve available Equipment Conditions
...
...

no
...
Equipment Conditions
...
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>



EQP_STATUS
Retrieve available Equipment Statuses
...
...

no
...
Equipment Statuses
...
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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
Retrieve available VLANs
...
...

no
...
VLAN
...
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <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>



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
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


The status of the Equipment
eqp_catalog
yes
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Recid of the Equipment Catalog item
location
no
Integer
Listsno
Integer
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Recid of Location
owner
no*
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Recid of parent Equipment, if applicable
cabling_equipment_type
no
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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*
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Recid(s) of Expense Type(s). 
*Conditionally Required if GLA is specified
...
Request Example
Call:
 Code Block
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
Results
If the request is successful, the equipment RECID will be returns as follows:
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>46521</equipment>
    </equipment>
...
cloak
Equipment VLANs
Equipment can be assigned to one or more VLANs.
...
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
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
908
vlan1
Results
If the request is successful, the Recid(s) will be returned in the same order provided:
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>
            <item>908</item>
            <item>909</item>
        </equipment>
    </equipment>
...
cloak
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
...
. 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
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
456231
remarksThis 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

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>0</total_count>
        <equipment>456231<equipment>
    </equipment>
...
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
IntegerLists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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
Listsfrom the Charge.
override_gla
no
Integer
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Recid of GLA to override default GLA with.
stop_datenoString

The Date the Recurring Charge should stop on. YYYY-MM-DD format.
effectivenoStringtoday, backdatetodayEffective flag for the 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
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
58337
charge_recid1
Results
If the request is successful, the RECID of the new Equipment charge is returned as follows:
 Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <equipment>58337</equipment>
    <equipment>58337</equipment>
    </equipment>
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).
...
cloak
</equipment>

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 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


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 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


The type(s) of GLA(s).
Request Example
Call:
 Code Block
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
2345
gla1
gla_percent100
gla_typeDefault
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

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <equipment>
            <item>2345</item>
            <item>2346</item>
        </equipment>
   </equipment>
    </equipment>
...
 </equipment>
Image Added
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 
 Toggle cloak
 Cloak
...
Image Removed
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
...
Record ID(s) of the Contact(s).
...
 Insert excerpt
API
API
nopaneltrue


Record ID(s) of the Contact(s).
Request Example
Call:
 Code Block
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
2345
contact1
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

 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <equipment><count>1</count>
        <status>success</status><total_count>1</total_count>
        <equipment>
   <page>1</page>         <count>1</count><item>1234</item>
            <total_count>1</total_count><item>1235</item>
        </equipment>
<equipment>             <item>1234</item>
            <item>1235</item>
        </equipment>
    </equipment>
...
 Cloak
Image Removed
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>
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-RECIDYes*Integer

UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value
  • See Note Below
udf_UDF-IDENTIFIERYes*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
languagephp
POST DOMAIN/KEY/equipment.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
765
udf_UDF-RECID1
Results
If the request is successful, the RECID(s) of the new Equipment UDF records will be returned same order provided:
 Toggle cloak
 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>

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