/api/pins

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"?>
<pins>
  <pin>
      <c_ode>5:26:measurement</c_ode>
      <type>MEASUREMENT</type>
      <min>0</min>
      <max>80</max>
      <units>m/min</units>
      <points>1</points>
   </pin>
</pins>

NOTE: In the above example, the word 'code' has been replaced with the word 'c_ode' due to our wiki syntax. In the real XML, the name of the element is 'code'.

Success (JSON)
[
    {
        "code":"5:27:measurement",
        "type":"MEASUREMENT",
        "min":"0",
        "max":"80",
        "units":"m\/min",
        "points":"1"
     }
]

Alternate Calling Method

http://ardiserver.com/s/sitename/api/lookuppoints?pins=2&pin0=5:10:text&pin1=5:11:text

This version of the function has exactly the same outcome - the parameters are simply passed in differently.

Additional Data

This function may also provide display details for the property. This includes how to map values to colours and gradients.