Versions Compared

Old Version 6

changes.mady.by.user Brian Dixon

Saved on

compared with

New Version 7

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

...

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>
...
Charges can be easily added to Equipment. If multiple charges Charges need to be added to Equipment, then separate POST requests will need to be made.
Below is the proper format for making a separate request. Note "TYPE=CHARGES" to indicate that this is to create an Equipment charge Charge record.
 Code Block
POST http://DOMAIN/api/API_KEY/equipment.OUTPUT?TYPE=CHARGES&field1=value1 ...
...
Field
Required
Data Type
Options
Default
Notes
recid
Conditionallyno*
Integer


*Conditionally Required if attempting to UPDATE an Equipment Charge
equipment_recid
yes
Integer


The RECID of the Equipment that the charge Charge is for
charge_recid
yes
Integer
Lists

RECID of the applicable charge catalogCharge Catalog.
description
no
String


The details or description Description of the charge Charge on the Equipment
amount
no*
Float


The amount to be charged. *Conditionally Required if charge does not have an amount on it.
quantity
no
Integer

1
Quantity of charge Charge to be used.
prorate
no
Integer
1 or 0
0
Should the charge Charge be prorated when activated
bill_date
no
String


Date the charge Charge was billed
override_amount
no
Float


If allowed by the selected chargeCharge, overrides the default amount from the chargeCharge.
override_gla
no
Integer
Lists

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 Charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API
...
GLAs can be easily added to Equipment. If multiple charges Charges need to be added to Equipment, then separate each value with commas.
...
Field
Required
Data Type
Options
Default
Notes
equipment_recid
yes
Integer


The RECID of the Equipment that the charge 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).
...
Field
Required
Data Type
Options
Default
Notes
equipment_recid
yes
Integer


The RECID of the Equipment that the charge Charge is for
contact
yes
String
Lists

Record ID(s) of the contactContact(s).
Results
 Toggle cloak
 Cloak
If the request is successful, the RECID(s) of the new Equipment contact records will be returned in same order provided:
 Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <equipment>
            <item>1234</item>
            <item>1235</item>
        </equipment>
    </equipment>
...
User Defined Fields can be easily set for Equipment. To get a list of available UDFs for a piece of equipmentEquipment, 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.
...
Field
Required
Data Type
Options
Default
Notes
equipment_recid
yes
Integer


The RECID of the Equipment that the charge 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
...