GET v1/layers/{id}

Returns an app framework level given the right level id, HTTP status code "Not Found" will be returned if the level id does not match our records.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Level UUID to retrieve.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Returns a Property object with level specific data.

Property
NameDescriptionTypeAdditional information
name

Name of the property or venue.

 string

None.
settings

This property will be updated and retrieved in separate calls

 Collection of Setting

None.
enabled

This fields allows you to see if a property is enabled / disabled

 boolean

None.
id

Entity unique identifier.

 UUID

None.
type

Type of entity this abstract class represents.

 EntityLinkType

None.
parent

Parent entity, i.e. if this was a property (Venue), the company that the property belongs to.

 Entity

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "settings": [
    {
      "systemId": "sample string 1",
      "group": "sample string 2",
      "id": "sample string 3",
      "name": "sample string 4",
      "value": "sample string 5"
    },
    {
      "systemId": "sample string 1",
      "group": "sample string 2",
      "id": "sample string 3",
      "name": "sample string 4",
      "value": "sample string 5"
    }
  ],
  "enabled": true,
  "type": 1,
  "parent": {
    "type": 1
  }
}