| Input Variable |
Input Value |
Description |
| id |
Integer value |
A valid asset ID. You may use * as a wildcard. |
| tid |
Integer value |
A valid asset ID. You may use * as a wildcard. |
| cid |
String value |
A customer ID that is associated with assets. You may use * as a wildcard. |
| count |
Integer value |
This would be the number of records to return. |
| count_only |
String value |
Defines whether or not to return only the number of records. This is used in conjunction with the "page" variable or just to get the total number of records. Accepted values are "N" and "Y" (without the quotes). The default value is "N", and if this variable is excluded the detailed data is returned. |
| page |
Integer value |
This would be the number of the "page" of records to return. You must use a wildcard like "id=*" or "tid=*" to get paged records, and you must also include the "count" variable". Example: &id=*&count=10&page=1. |
| order |
String value |
Defines the sort order of the returned records. You will need to examine the database to determine the exact field names to sort by. You may also include " ASC" (ascending) and " DESC" (descending) in the value for the sort direction (note the precedding blank space). For example, to sort by ID in descending order you would include the following in the URL: &order=ID DESC. You can optionally include the "order_direction" variable separately. |
| order_direction |
String value |
Defines the sort order direction of the returned records. Accepted values are "ASC" (ascending) and "DESC" (descending). The default value is "ASC". For example, to sort by ID in descending order you would include the following in the URL: &order=ID&order_direction=DESC. |
| Output Variable |
URL Encoded |
Description |
| id |
No |
Unique ID of the asset. |
| ticket_number |
Yes |
The ticket ID that the asset is associated with. |
| date_added |
No |
The date the asset was added. |
| added_by |
No |
The technician ID of the technician that added the asset. |
| last_updated |
No |
The date/time the asset was last updated. |
| updated_by |
No |
The technician ID of the technician that edited the asset. |
| asset_fields |
No |
Sub-section that contains the asset fields and their values. For delimited output, the field names are a comma delimited list of names and field values are in variables with those names. |
| Example Usage |
| http://localhost/API/default.aspx?key=your key here&action=get_assets&id=* |
| Example Response |
| XML: |
<?xml version="1.0"?>
<assets>
<asset>
<id>6</id>
<ticket_number>123</ticket_number>
<date_added>4/22/2014 7:53:06 PM</date_added>
<added_by>admin</added_by>
<last_updated></last_updated>
<updated_by></updated_by>
<asset_fields>
<field 1>value 1</field 1>
<field 2>value 2</field 2>
<test>value 3</test>
<test_2>value 4</test_2>
<aaaaaaaa>value 5</aaaaaaaa>
<new_field>value 6</new_field>
</asset_fields>
<associated_customers>|44444|55555|demo|test|</associated_customers>
</asset>
</assets> |
| JSON: |
{
"assets": [
{
"id" : "6",
"ticket_number" : "",
"date_added" : "4/22/2014 7:53:06 PM",
"added_by" : "admin",
"last_updated" : "",
"updated_by" : "",
"asset_fields" : [
{
"a" : "",
"b" : "",
"test" : "",
"test_2" : "",
"aaaaaaaa" : "",
"new_field" : ""
}
],
"associated_customers" : "|44444|55555|demo|test|"
}
]
} |
| URL DELIMITED: |
id=6&ticket_number=&date_added=4/22/2014 7:53:06 PM&added_by=admin&last_updated=&updated_by=&a=&b=&test=&test_2=
&aaaaaaaa=&new_field=&asset_fields=a,b,test,test_2,aaaaaaaa,new_field&associated_customers=|44444|55555|demo|test| |
