This is an old revision of the document!


/api/lookuppoints

Usage

This function is used to bulk-convert point names in ARDIs internal codes into human readable values. Point codes are made up of the asset id, property id and node delimited by a colon, such as 12:22:measurement.

These can be queried one of two ways - with all of the pins in a single parameter, or one pin per parameter.

Details

DetailValue
GroupAsset
From Server Version2025.0.0
PermissionGuest
MethodsGET or POST
Parameters
ParameterNotesMeaning
pinsInteger [Required]A semi-colon (;) delimited list of codes, or the number of pin parameters
pinxString [Optional]Individual pin values
formatString (xml)Either 'xml' or 'json'

Examples

Call
http://ardiserver.com/s/sitename/api/lookuppoints?pins=5:10:text;5:11:text
Success (XML)
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  
Success (JSON)