Page Comparison

Table of Contents

outline	true
style	none

...

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

Toggle cloak

Cloak

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

...

Type

Description

Extra Parameters*

Searchable

Results

CONTACTS

Retrieve available Contacts

CTYPE - Type of contact. Example: "worker"

yes

Contacts

Toggle cloak

Cloak

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

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

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

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>

GLAS

Retrieve available GLAs

no

GLA

Toggle cloak

Cloak

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

Retrieve available Locations

yes

Locations

Toggle cloak

Cloak

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

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

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>

EQP_CONDITION

Retrieve available Equipment Conditions

no

Equipment Conditions

Toggle cloak

Cloak

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>

EQP_STATUS

Retrieve available Equipment Statuses

no

Equipment Statuses

Toggle cloak

Cloak

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

Retrieve available VLANs

no

VLAN

Toggle cloak

Cloak

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

no*

Integer

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

status

yes

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

The status of the Equipment

eqp_catalog

yes

Integer

Value Lookups:

Toggle cloak

Recid of the Equipment Catalog item

location

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Cloak

Insert excerpt

	API
	API
nopanel	true

Recid of Location

owner

no*

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Recid of parent Equipment, if applicable

cabling_equipment_type

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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. warranty_end_date is automatically set when received_date is provided

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

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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

...

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

...

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

Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": "0",
    "equipment": 46521
}

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	908
vlan	1

...

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

Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": 1,
    "equipment": [
        {
            "item": 908,
            "item": 909
        }
    ]
}

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	456231
remarks	This is a Remark from the API

...

If the request is successful, the Recid of the remark record will be returned as follows:

Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": 0,
    "equipment": 456231
}

...

Field

Required

Data Type

Options

Default

Notes

recid

no*

Integer

*Conditionally Required if attempting to UPDATE an Equipment Charge. RECID column from EQUIPMENT_CHARGES table.

equipment_recid

yes

Integer

The RECID of the Equipment that the Charge is for.

charge_recid

yes

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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. Only allowed if Charge Catalog allows it.

prorate

no

Integer

1 or 0

0

Should the Charge be prorated when activated. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false

start_date

no

String

MRC

ARC

The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results.

Used for Monthly Recurring Charges and Alternate Recurring Charges.

stop_date

no

String

MCR

ARC

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Monthly Recurring Charges and Alternate Recurring Charges

recurring_date

no

String

ARC

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Alternate Recurring Charges

transaction_date

no

String

NRC

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Non-Recurring Charges

override_amount

no

Decimal

If allowed by the selected Charge, overrides the default amount from the Charge.

override_gla

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

RECID of GLA to override default GLA with. The Override GLA Format should match the Billing Group Format of the Equipment.

effective

no

String

today, backdate

today

Effective flag for the Charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API

Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date.

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	58337
charge_recid	1

...

If the request is successful, the RECID of the new Equipment charge is returned as follows:

Toggle cloak

Cloak

Code Block

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": 1,
    "equipment": 58337
}

...

Field

Required

Data Type

Options

Default

Notes

equipment_recid

yes

Integer

RECID column from EQUIPMENT table.

gla

yes

String

Value Lookups:

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

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

The type(s) of GLA(s).

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	2345
gla	1
gla_percent	100
gla_type	Default

...

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

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": 1,
    "equipment": [
        {
            "item": 2345,
            "item": 2346
        }
    ]
}

...

Field

Required

Data Type

Options

Default

Notes

equipment_recid

yes

Integer

RECID column from EQUIPMENT table.

contact

yes

String

Value Lookups:

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Record ID(s) of the Contact(s).

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	2345
contact	1

...

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

language	php
linenumbers	true

{
    "status": "success",
    "page": 1,
    "count": 1,
    "total_count": 1,
    "equipment": [
        {
            "item": 1234,
            "item": 1235
        }
    ]
}

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
status	Active
eqp_catalog	1
billable	0
consumed	0
use_dhcp	0
private	0
equipment_recid	765
udf_UDF-RECID	1

...

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
{ "status": "success", "page": 1, "count": 1, "total_count": 1, "equipment": [ { "item": 765, "item": 766 } ] }

...

Versions Compared

Old Version 1

New Version 2

Key

Results

Body:

Body:

Body:

Body:

Body:

Body:

Body: