This is an old revision of the document!


/api/asset/show

Usage

This function is used to search for an asset based on a query string and display a page in the users browser.

This search is limited to the specific property IDs or names you'd like to limit it to.

Details

DetailValue
GroupAsset
From Server Version0.9.0
PermissionGuest
MethodsGET or POST
Parameters
ParameterNotesMeaning
searchString [Required]The text to search for
propertyString [Optional]The id of the property to be searched
proptypeString [Optional]The type of property to be searched
viewString [Optional]The page to open. Defaults to 'dash'
formatString (xml)'' (empty), 'xml' or 'json'

Usage

Calling this function without a value for property or propertytype searches all properties.

Calling this function with a property type in all-caps (ie. 'MEASUREMENT') searches all properties of that type.

You can use either the name or the ID of a property in the 'property' parameter.

If called without a 'format' parameter, the user is redirected to the URL.

Values for 'view' include…

CodeLocation
360360 Photography (if available)
dashThe ARDI Dashboard
dexploreData Explorer
mediaThe ARDI Media List

Examples

Call
http://ardiserver.com/s/sitename/api/asset/show?q=REFNUMBER&format=json
Success (JSON)
{
     "id": 20,
     "name": "The Asset Name",
     "url": "s/sitename/dashboard/20"
}