Page Comparison

Table of Contents

outline	true
style	none

...

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>

Write Call

Insert excerpt

	SQL API Calls
	SQL API Calls
nopanel	true

Available Fields

Field

Required

Data Type

Options

Default

Notes

RECID

no*

Integer

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

status

yes

Integer

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

The status of the Equipment

eqp_catalog

yes

Integer

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Recid of the Equipment Catalog item

location

no

Integer

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Recid of Location

owner

no*

Integer

Lists

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

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Recid of parent Equipment, if applicable

cabling_equipment_type

no

Integer

Lists

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

Lists

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

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

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

Lists

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

...

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

...

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

...

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

...

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

...

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

Body:

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

...

Field	Required	Data Type	Notes
equipment_recid	Yes	Integer	RECID column from EQUIPMENT table.
udf_UDF-RECID	Yes*	Integer	UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value 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

...

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

...

Versions Compared

Old Version 6

New Version 7

Key

Write Call

Available Fields

Body:

Body:

Body:

Body:

Body:

Body:

Body: