/api/asset/info
Usage
This function is used to get property information about a particular asset (specified with 'ID').
You can capture more complete information about an asset using /api/asset/detail, which includes relationship information, effects and media.
Note however that the info function is significantly faster than the above, particularly if media and relationship information is not required.
Details
| Detail | Value |
|---|---|
| Group | Asset |
| From Server Version | 0.9.0 |
| Permission | Guest |
| Methods | GET or POST |
Parameters
| Parameter | Notes | Meaning |
|---|---|---|
| id | Number [Required] | The ID of the asset |
| format | String (xml) | Either 'xml' or 'json' |
| live | Boolean (false) | If live data should be included* |
| fetch | Boolean (false) | If external data (ie. from addons) should be included* |
* Both the live and fetch parameters have a computational time impact. If you are retrieving values from many assets at once or plan to connect to live data, you should consider leaving these at 'false'.
Examples
Call
http://ardiserver.com/api/asset/info?id=5
Success (XML)
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <asset name="Site" id="5" ern=""> <property name="Address" id="3" type="ADDRESS" origin="5" origintype="local"> <address>10/75 Cygnet Avenue, Shellharbour City Center, NSW, Australia</address> </property> </asset>
Success (JSON)
{
"name": "III Office",
"id": "5",
"ern": "",
"property": [{
"name": "Address",
"id": "3",
"type": "ADDRESS",
"origin": "5",
"origintype": "local",
"address": ["18\/2 Memorial Drive, Shellharbour City Center, NSW, Australia"]
}]
}