GET /profiles

<< Click to Display Table of Contents >>

Navigation:  The API > JSON Adminstrator API > REST Resources > Profiles > GET >

GET /profiles

Profile Overview

Get informations of profiles known to the gateway

In the Admin API, the call "GET /profiles" delivers basically the same content as "GET /profiles" from the User API but with the following additional information:

Array of Variations

Version

 

Client to Gateway:

Resource Path

HTTP method

/profiles

GET

no additional call parameters are necessary

 

Response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

standard header object with

content = profiles

profiles

array of objects

[{}]

array of profile objects

 

eep

string

xx-xx-xx

EnOcean Equipment Profiles, definition of Enocean radio telegram structure

 

title

string

 

short description of eep profile

 

variations

array of objects

[{}]

 

followed by:

Per key multiple or none iterations

 

variations

array of obejcts

[{}]

array of an eep variation object

 

 

version

string

 

eepVariation and version

 

 

variation

string

 

 

version

 

string

 

version of the API

example:

Basic structure of gateway response:

 

http://hostname:api_port/profiles
 
{
  "header" : {
    "httpStatus" : 200,
    "content" : "profiles",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-02-22T17:31:48.211+0100"
  },
  "profiles" : [ {
    "eep" : "A5-02-01",
    "title" : "Temperature Sensors, Temperature Sensor Range -40°C to 0°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-02",
    "title" : "Temperature Sensors, Temperature Sensor Range -30°C to +10°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-03",
    "title" : "Temperature Sensors, Temperature Sensor Range -20°C to +20°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-04",
    "title" : "Temperature Sensors, Temperature Sensor Range -10°C to +30°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-05",
    "title" : "Temperature Sensors, Temperature Sensor Range 0°C to +40°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-06",
    "title" : "Temperature Sensors, Temperature Sensor Range +10°C to +50°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-07",
    "title" : "Temperature Sensors, Temperature Sensor Range +20°C to +60°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-08",
    "title" : "Temperature Sensors, Temperature Sensor Range +30°C to +70°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-09",
    "title" : "Temperature Sensors, Temperature Sensor Range +40°C to +80°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-0A",
    "title" : "Temperature Sensors, Temperature Sensor Range +50°C to +90°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-0B",
    "title" : "Temperature Sensors, Temperature Sensor Range +60°C to +100°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-10",
    "title" : "Temperature Sensors, Temperature Sensor Range -60°C to +20°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-11",
    "title" : "Temperature Sensors, Temperature Sensor Range -50°C to +30°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-12",
    "title" : "Temperature Sensors, Temperature Sensor Range -40°C to +40°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-13",
    "title" : "Temperature Sensors, Temperature Sensor Range -30°C to +50°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-14",
    "title" : "Temperature Sensors, Temperature Sensor Range -20°C to +60°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-15",
    "title" : "Temperature Sensors, Temperature Sensor Range -10°C to +70°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-16",
    "title" : "Temperature Sensors, Temperature Sensor Range 0°C to +80°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-17",
    "title" : "Temperature Sensors, Temperature Sensor Range +10°C to +90°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-18",
    "title" : "Temperature Sensors, Temperature Sensor Range +20°C to +100°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-19",
    "title" : "Temperature Sensors, Temperature Sensor Range +30°C to +110°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-1A",
    "title" : "Temperature Sensors, Temperature Sensor Range +40°C to +120°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-1B",
    "title" : "Temperature Sensors, Temperature Sensor Range +50°C to +130°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-20",
    "title" : "Temperature Sensors, 10 Bit Temperature Sensor Range -10°C to +41.2°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-02-30",
    "title" : "Temperature Sensors, 10 Bit Temperature Sensor Range -40°C to +62.3°C",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-04-01",
    "title" : "Temperature and Humidity Sensor, Range 0°C to +40°C and 0% to 100%",
    "variations" : [ {
      "version" : "1.0"
    }, {
      "variation" : "alphaEOS_SENSETF-H",
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-04-02",
    "title" : "Temperature and Humidity Sensor, Range -20°C to +60°C and 0% to 100%",
    "variations" : [ {
      "version" : "1.0"
    }, {
      "variation" : "Eltako_FAFT60,FIFT65S,FBH65TFB",
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-04-03",
    "title" : "Temperature and Humidity Sensor, Range -20°C to +60°C 10bit-measurement and 0% to 100%",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-05-01",
    "title" : "Barometric Sensor, Range 500 to 1150 hPa",
    "variations" : [ {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-06-01",
    "title" : "Light Sensor, Range 300lx to 60.000lx",
    "variations" : [ {
      "variation" : "Eltako_FAH60,FAH60B,FAH65S,FIH65S",
      "version" : "1.0"
    }, {
      "version" : "1.0"
    } ]
  }, {
    "eep" : "A5-06-02",
    "title" : "Light Sensor, Range 0lx to 1.020lx",
    "variations" : [ {
      "version" : "1.0"
    }, {
      "variation" : "Eltako_FIH65B",
      "version" : "1.0"
    } ]
  }