Versions Compared

Key

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

Table of Contents
outlinetrue
stylenone

...

Type

Description

Extra Parameters*

Searchable

Results

CONTACTS

Retrieve available Contacts

CTYPE - Type of contact. Example: "worker"

yesResults

Contacts

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

...

languagephp
linenumberstrue

...

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

...