Versions Compared

Old Version 5

changes.mady.by.user Jeremiah Sokolowski

Saved on

compared with

New Version 6

changes.mady.by.user Brian Dixon

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue
stylenone

...

Name

Datatype

Searchable

Notes

BILLABLE

Yes/No

Yes

To indicate whether the equipment Equipment item is or is not billableBillable.

EQUIPMENT_ID

string

Yes

Unique identifier of a piece of equipmentEquipment; this is required for data equipmentEquipment.

ASSET_TAG

string

Yes

Unique identifier of a piece of equipmentEquipment; this is required for assetsAssets.

SERIAL_NUM

string

Yes

A unique identifier for one individual instance of a piece of equipmentEquipment; often supplied by the manufacturer.

PURCHASE_PRICE /
PURCHASE_PRICE_GREATER /
PURCHASE_PRICE_LESS

number

Yes

The price paid upon purchase of the equipmentEquipment. 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 Equipment was received.

BILLED_DATE

string

Yes

Date the piece of equipment Equipment was billed.

CATALOG

string

Yes

Equipment part number.

OWNER

string

Yes

The Contact or Dept Hierarchy that owns this piece of equipmentEquipment.

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 Location of the piece of equipmentEquipment; use LOCATIONS for search.

EQP_STATUS

string

Yes

Current status of the piece of equipmentEquipment. Use STATUS for search.

EQUIPMENT_UDF

list

No

List of all the User Defined Fields and the selected values for this piece of equipmentEquipment.

EQUIPMENT_CHARGES

list

No

Charges listed for the piece of equipmentEquipment.

EQUIPMENT_CONTACTS

list

No

Contacts associated with the piece of equipmentEquipment.

EQUIPMENT_EXPENSE_GLA

list

No

Expense G/L Accounts to be used for billing for the piece of equipmentEquipment.

EQUIPMENT_REMARKS

list

No

List of all remarks/comments for the piece of equipmentEquipment.

Results
Toggle cloak
 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/>
                </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>
...
 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 Results
 Anchor
locations
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>
UDF Results
 Anchor
udf
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>
...
Field
Required
Data Type
Options
Default
Notes
RECIDonly 
 when updatingno*
Integer


Identifier of the record to be updated
*Conditionally Required for updating
status
yes
Integer
Lists

The status of the equipmentEquipment
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 ownerOwner
*Conditionally Required for updating
owner_type
no*
String
"contact" or "department"

Type of ownerOwner.
*Conditionally Required only when setting an ownerOwner
serial_number
no
String


Serial number of equipmentEquipment
serial_number_barcode
no
String


Serial number barcode of equipmentEquipment
equipment_id
no
String


ID of equipmentEquipment
asset_tag
no
String


Asset tag of the equipmentEquipment
billable
yes
Integer
1 = yes; 0 = no

Designate if the equipment Equipment is billableBillable
consumed
yes
Integer
1 = yes; 0 = no

Designate if the equipment Equipment is consumed
purchase_price
no
Decimal


Purchase price of the equipmentEquipment
received_date
no
String


Date equipment Equipment was received
billed_date
no
String


Date equipment Equipment was billed
card_number
no
String


Card number of equipmentEquipment
parent_equipment
no
Integer
Lists

Recid of parent equipmentEquipment, if applicable
cabling_equipment_type
no
Integer
Lists

Recid of Cabling Equipment type
ip4_gateway
no
String


IPv4 address of gateway for equipmentEquipment
ip6_gateway
no
String


IPv6 address of gateway for equipmentEquipment
lan_name
no
String


Name of LAN equipment Equipment is attached to
mac
no
String


MAC address of equipmentEquipment
ip4
no
String


IPv4 address of equipmentEquipment
ip6
no
String


IPv6 address of equipmentEquipment
ip4_subnet
no
String


IPv4 address for subnet that equipment Equipment is attached to
ip6_subnet
no
String


IPv6 address for subnet that equipment 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 equipmentEquipment
condition
no
Integer
Lists

Recid of condition value for equipmentEquipment.
ordered_date
no
String


Date equipment Equipment was ordered
units
no



Quantity on hand
warranty_end_date
no
String


Date that warranty ends on equipmentEquipment
use_dhcp
yes
Integer
1 = yes; 0 = no

Designate if the equipment Equipment uses DHCP
private
yes
Integer
1 = yes; 0 = no

Designate if this equipment 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 Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is required 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

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