Admin Floor Spaces (v1)

The Floor Space API provides access to create, read and update floor space resources. Floor Spaces define a local positioning coordinate system in meter. They also can define a transformation between the local coordinate system to the global coordinate system via the geotransform attributes. Floor Spaces are a component of the organizational hierarchy and reside under the floors in the hierarchy.

GetFloorSpacesWithLightsMapsById

Retrieves a single floor space resource with maps and lights.

Test Route

Try it

Note: When you click on the Try It button you may see the following warning message: "" You can ignore this warning message and proceed by entering appropriate values for any query parameters and required header values.

Request URL

Request parameters

integer

A unique numerical floor space resource identifier.

Request headers

string

Environment in which to execute the request.

string

A GUID identifier for requesting partner specific resources.

string

String value representing userid or application name issuing the request.

string

A string identifier for authenticating subscription specific resources.

Request body

Response 200

Returns a floor space with lights and types resource.

{
  "floorSpace": {
    "role_ID": 1,
    "roleName": "Demo Role",
    "floorSpaceMaps": {
      "GTWidth": 0.0050977830783194749,
      "epsg_ID": 3857,
      "displayImageUrl": "https://__ASSET_SA__.blob.core.windows.net/f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1/floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6/map@2x.png",
      "imagePixelWidth": 8250,
      "GTYRotation": 5.0158750156886082E-05,
      "GTXRotation": 5.0158750156886082E-05,
      "floorSpaceWidth": 21.03,
      "GTHeight": -0.0050977830783194749,
      "containerName": "f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1",
      "imagePixelHeight": 5250,
      "floorSpaceLength": 13.38,
      "imageMetersPerPixel": 0.002548,
      "GTX": -9355560.3558281623,
      "GTY": 3985950.8758218605,
      "folderName": "floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6",
      "displayName": "Demo Floor Space Map",
      "tiledImageUrl": null
    },
    "floorSpaceID": 1,
    "site_ID": 1,
    "floorSpaceName": "Demo floor space",
    "cellWidth": 2,
    "cellLength": 4,
    "floorSpaceWidth": 20,
    "floorSpaceLength": 30,
    "gridXOffset": 0,
    "gridYOffset": 0,
    "mapOffsetX": 0,
    "mapOffsetY": 0,
    "maxMountingHeight": 10,
    "coordinateConversionRule": 0,
    "mapAngleOffsetRadians": null,
    "hasBLEBeacons": true,
    "fixtureType": "BLT",
    "operatingPoint": 100,
    "VLCEnabled": true,
    "floor_ID": 1,
    "GTXRotation": 9.6916E-08,
    "GTYRotation": -8.1282E-08,
    "GTWidth": -1.1056632E-05,
    "GTHeight": -9.24342E-06,
    "GTX": -84.0419236132,
    "GTY": 33.6800256587,
    "GTHeadingOffset": 3.14,
    "GTImageOrigin": "ul",
    "active": true,
    "VLCIDUpperLimit": 2000,
    "mobileFloorSpaceOptions": {
      "thresholdRssi": -80,
      "topBeaconThresholdRssi": 6,
      "accuracyBLE": 3,
      "floorRssiGain": 0,
      "staleBeaconThreshold": 5
    }
  },
  "luminaireTypes": [
    {
      "luminaireTypeID": 1,
      "organization_ID": 1,
      "displayName": "Demo Luminaire",
      "exteriorWidth": 0.6096,
      "exteriorLength": 0.6096,
      "interiorWidth": 0.6096,
      "interiorLength": 0.6096,
      "reportingType": "cls"
    }
  ],
  "luminaireSummary": [
    {
      "vlcID": 1,
      "bleBeaconID": 1,
      "BLEBeaconUUId": "asdf1535",
      "floorSpace_ID": 1,
      "floorSpaceName": "Demo Floor Space",
      "xMeters": -8.737702,
      "yMeters": -1.8288,
      "xFt": 28.666995668,
      "yFt": 6.000000192,
      "width": 2,
      "height": 4,
      "luminaireLabel": 0,
      "flagNotes": "",
      "controlGroup_ID": 1,
      "externalWidth": 2,
      "externalLength": 4,
      "vlcEnabled": true,
      "ciCode": "000000",
      "locationDescription": "Back Left Corner",
      "reportingType": "cls",
      "luminaireType_ID": "1",
      "luminaireTypeDisplayName": "TestLuminaire"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "floorSpace": {
      "type": "object",
      "properties": {
        "floorSpaceMaps": {
          "description": "Array of associated floor space maps",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "mapID": {
                "format": "int32",
                "description": "A unique numerical identifier of the map resource",
                "type": "integer"
              },
              "floorSpace_ID": {
                "format": "int32",
                "description": "A numerical identifier that associates a map to a floor space resource",
                "type": "integer"
              },
              "displayName": {
                "description": "The name of a map",
                "type": "string"
              },
              "displayImageUrl": {
                "description": "Generated URL of the uploaded floor space map",
                "type": "string"
              },
              "tiledImageUrl": {
                "description": "Generated URL of the tiled floor space map",
                "type": "string"
              },
              "imagePixelHeight": {
                "format": "int32",
                "description": "Height of image in pixel",
                "type": "integer"
              },
              "imagePixelWidth": {
                "format": "int32",
                "description": "Width of image in pixel",
                "type": "integer"
              },
              "floorSpaceLength": {
                "format": "double",
                "description": "Height of image in meter",
                "type": "number"
              },
              "floorSpaceWidth": {
                "format": "double",
                "description": "Width of image in meter",
                "type": "number"
              },
              "imageMetersPerPixel": {
                "format": "double",
                "description": "Meters per Pixel of the image",
                "type": "number"
              },
              "effectiveFrom": {
                "format": "date-time",
                "description": "Start time in which floor space is valid",
                "type": "string"
              },
              "effectiveTo": {
                "format": "date-time",
                "description": "End time in which floor space is valid",
                "type": "string"
              },
              "folderName": {
                "description": "Generated blob storage folder path",
                "type": "string"
              },
              "containerName": {
                "description": "Generated blob storage container name",
                "type": "string"
              },
              "GTXRotation": {
                "format": "double",
                "description": "Row Rotation",
                "type": "number"
              },
              "GTYRotation": {
                "format": "double",
                "description": "Column rotation",
                "type": "number"
              },
              "GTWidth": {
                "format": "double",
                "description": "Width of a pixel in the image",
                "type": "number"
              },
              "GTHeight": {
                "format": "double",
                "description": "Height of a pixel in the image",
                "type": "number"
              },
              "GTX": {
                "format": "double",
                "description": "X coordinate of the of the upper-left corner of the upper-left pixel of the image",
                "type": "number"
              },
              "GTY": {
                "format": "double",
                "description": "Y coordinate of the of the upper-left corner of the upper-left pixel of the image",
                "type": "number"
              },
              "epsg_ID": {
                "format": "int32",
                "description": "EPSG Identifier - 4326 = WGS84 AKA world. 3857 = Web Mercator. Check out http://spatialreference.org/ for more info.",
                "type": "integer"
              }
            },
            "example": {
              "mapID": 1,
              "floorSpace_ID": 1,
              "displayName": "Demo Floor Space Map",
              "displayImageUrl": "https://__ASSET_SA__.blob.core.windows.net/f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1/floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6/map@2x.png",
              "tiledImageUrl": null,
              "imagePixelHeight": 5250,
              "imagePixelWidth": 8250,
              "floorSpaceLength": 13.38,
              "floorSpaceWidth": 21.03,
              "imageMetersPerPixel": 0.002548,
              "effectiveFrom": "2017-07-25 18:36:04.3620794",
              "effectiveTo": null,
              "folderName": "floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6",
              "containerName": "f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1",
              "GTXRotation": 5.0158750156886082E-05,
              "GTYRotation": 5.0158750156886082E-05,
              "GTWidth": 0.0050977830783194749,
              "GTHeight": -0.0050977830783194749,
              "GTX": -9355560.3558281623,
              "GTY": 3985950.8758218605,
              "epsg_ID": 3857
            }
          }
        },
        "floorSpaceID": {
          "format": "int32",
          "description": "A unique numerical identifier of the floor space resource",
          "type": "integer"
        },
        "site_ID": {
          "format": "int32",
          "description": "A numerical identifier that associates a floor space to a site resource",
          "type": "integer"
        },
        "floorSpaceName": {
          "description": "User friendly name for floor space",
          "type": "string"
        },
        "cellWidth": {
          "format": "double",
          "type": "number",
          "description": "Width of Luminaire Grid (feet)"
        },
        "cellLength": {
          "format": "double",
          "type": "number",
          "description": "Length of Luminaire Grid (feet)"
        },
        "floorSpaceWidth": {
          "format": "double",
          "description": "Physical width of floor space in meter",
          "type": "number"
        },
        "floorSpaceLength": {
          "format": "double",
          "description": "Physical length of floor space in meter",
          "type": "number"
        },
        "gridXOffset": {
          "format": "double",
          "type": "number",
          "description": "X offset of luminaire grid"
        },
        "gridYOffset": {
          "format": "double",
          "type": "number",
          "description": "Y offset of luminaire grid"
        },
        "mapOffsetX": {
          "format": "double",
          "type": "number",
          "description": "X offset of floor space from floor space map image. This is from the upper left corner of the image to the upper left corner of the floor space"
        },
        "mapOffsetY": {
          "format": "double",
          "type": "number",
          "description": "Y offset of floor space from floor space map image. This is from the upper left corner of the image to the upper left corner of the floor space"
        },
        "maxMountingHeight": {
          "format": "double",
          "type": "number",
          "description": "Maximum mounting height of luminaries"
        },
        "coordinateConversionRule": {
          "format": "int32",
          "type": "integer",
          "description": "Coordinate plane rules. (0 = Normal, 1 = Negate X, 2 = Negate Y, 3 = Negate X and Y, 4 = Swap X/Y, 5 = Swap X/Y and Negate X, 6 = Swap X/Y and Negate Y, 7 = Swap X/Y and Negate X and Y)"
        },
        "mapAngleOffsetRadians": {
          "format": "double",
          "type": "number",
          "description": "Map offset rotation (radians)"
        },
        "hasBLEBeacons": {
          "type": "boolean",
          "description": "Defines if BLE is enabled"
        },
        "fixtureType": {
          "type": "string",
          "description": "Luminaire type"
        },
        "operatingPoint": {
          "format": "double",
          "type": "number",
          "description": "Luminaire operating point"
        },
        "VLCEnabled": {
          "description": "Defines if VLC is enabled",
          "type": "boolean"
        },
        "floor_ID": {
          "format": "int32",
          "description": "A numerical identifier that associates a floor space to a floor resource",
          "type": "integer"
        },
        "GTXRotation": {
          "format": "double",
          "description": "Geotransform X Rotation",
          "type": "number"
        },
        "GTYRotation": {
          "format": "double",
          "description": "Geotransform Y Rotation",
          "type": "number"
        },
        "GTWidth": {
          "format": "double",
          "description": "Geotransform Width",
          "type": "number"
        },
        "GTHeight": {
          "format": "double",
          "description": "Geotransform Height",
          "type": "number"
        },
        "GTX": {
          "format": "double",
          "description": "Geogransform X",
          "type": "number"
        },
        "GTY": {
          "format": "double",
          "description": "Geogransform Y",
          "type": "number"
        },
        "GTHeadingOffset": {
          "format": "double",
          "description": "Heading Offset in Radians",
          "type": "number"
        },
        "GTImageOrigin": {
          "description": "Origin Corner of floor space in image. Used in conjunction with mapOffsetX and mapOffsetY to define the geotransform origin point of the floor space in the map image. Valid values: ul, ur, ll, lr",
          "type": "string"
        },
        "active": {
          "description": "Defines whether record is active.",
          "type": "boolean"
        },
        "mobileFloorSpaceOptions": {
          "type": "object",
          "properties": {
            "thresholdRssi": {
              "format": "int32",
              "description": "Threshold RSSI value for floorspace",
              "type": "integer"
            },
            "topBeaconThresholdRssi": {
              "format": "int32",
              "description": "Highest beacon threshold RSSI value for floorspace",
              "type": "integer"
            },
            "accuracyBLE": {
              "format": "int32",
              "description": "Accuracy value for BLE for floorspace",
              "type": "integer"
            },
            "floorRssiGain": {
              "format": "int32",
              "description": "RSSI gain value for the floorspace",
              "type": "integer"
            },
            "staleBeaconThreshold": {
              "format": "int32",
              "description": "Threshold to consider beacon is stale",
              "type": "integer"
            }
          },
          "example": {
            "thresholdRssi": -80,
            "topBeaconThresholdRssi": 6,
            "accuracyBLE": 3,
            "floorRssiGain": 0,
            "staleBeaconThreshold": 5
          },
          "description": "Mobile floor space options object"
        },
        "VLCIDUpperLimit": {
          "type": "integer",
          "description": "Maximum number of VLCIDs permitted for this floorspace",
          "format": "int32"
        },
        "hasVLC": {
          "type": "boolean",
          "description": "Floorspace supports VLC"
        }
      },
      "example": {
        "VLCIDUpperLimit": 2000,
        "hasVLC": true,
        "floorSpaceMaps": {
          "GTWidth": 0.0050977830783194749,
          "epsg_ID": 3857,
          "displayImageUrl": "https://__ASSET_SA__.blob.core.windows.net/f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1/floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6/map@2x.png",
          "imagePixelWidth": 8250,
          "GTYRotation": 5.0158750156886082E-05,
          "GTXRotation": 5.0158750156886082E-05,
          "floorSpaceWidth": 21.03,
          "GTHeight": -0.0050977830783194749,
          "containerName": "f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1",
          "imagePixelHeight": 5250,
          "floorSpaceLength": 13.38,
          "imageMetersPerPixel": 0.002548,
          "GTX": -9355560.3558281623,
          "GTY": 3985950.8758218605,
          "folderName": "floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6",
          "displayName": "Demo Floor Space Map",
          "tiledImageUrl": null
        },
        "floorSpaceID": 1,
        "site_ID": 1,
        "floorSpaceName": "Demo floor space",
        "cellWidth": 2,
        "cellLength": 4,
        "floorSpaceWidth": 20,
        "floorSpaceLength": 30,
        "gridXOffset": 0,
        "gridYOffset": 0,
        "mapOffsetX": 0,
        "mapOffsetY": 0,
        "maxMountingHeight": 10,
        "coordinateConversionRule": 0,
        "mapAngleOffsetRadians": null,
        "hasBLEBeacons": true,
        "fixtureType": "BLT",
        "operatingPoint": 100,
        "VLCEnabled": true,
        "floor_ID": 1,
        "GTXRotation": 9.6916E-08,
        "GTYRotation": -8.1282E-08,
        "GTWidth": -1.1056632E-05,
        "GTHeight": -9.24342E-06,
        "GTX": -84.0419236132,
        "GTY": 33.6800256587,
        "GTHeadingOffset": 3.14,
        "GTImageOrigin": "ul",
        "active": true,
        "mobileFloorSpaceOptions": {
          "staleBeaconThreshold": 5,
          "topBeaconThresholdRssi": 6,
          "floorRssiGain": 0,
          "thresholdRssi": -80,
          "accuracyBLE": 3
        }
      },
      "description": "Floor Space object"
    },
    "luminaireTypes": {
      "description": "Array of Luminaire Types",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "luminaireTypeID": {
            "format": "int32",
            "type": "integer",
            "description": "A unique numerical identifier of the luminaireType resource"
          },
          "organization_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaireType to an organization resource"
          },
          "displayName": {
            "type": "string",
            "description": "The name of a luminaireType"
          },
          "exteriorWidth": {
            "format": "double",
            "type": "number",
            "description": "Exterior Width of Luminaire (feet)"
          },
          "exteriorLength": {
            "format": "double",
            "type": "number",
            "description": "Exterior Length of Luminaire (feet)"
          },
          "interiorWidth": {
            "format": "double",
            "type": "number",
            "description": "Interior Width of Luminaire (feet)"
          },
          "interiorLength": {
            "format": "double",
            "type": "number",
            "description": "Interior Width of Luminaire (feet)"
          },
          "reportingType": {
            "type": "string",
            "description": "Reporting Type"
          }
        },
        "example": {
          "luminaireTypeID": 1,
          "organization_ID": 1,
          "displayName": "Demo Luminaire",
          "exteriorWidth": 0.6096,
          "exteriorLength": 0.6096,
          "interiorWidth": 0.6096,
          "interiorLength": 0.6096,
          "reportingType": "cls"
        }
      }
    },
    "luminaireSummary": {
      "description": "Array of Luminaire info",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "luminairePositionId": {
            "format": "int32",
            "type": "integer",
            "description": "A unique numerical identifier of the luminaire position resource"
          },
          "id": {
            "format": "int32",
            "type": "integer",
            "description": "VLC Identifier"
          },
          "floorSpace_ID": {
            "format": "int32",
            "description": "A unique numerical identifier of the floor space resource",
            "type": "integer"
          },
          "tag": {
            "type": "string",
            "description": "Luminaire Label"
          },
          "x1": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the lower left corner of the luminaire"
          },
          "x2": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the upper left corner of the luminaire"
          },
          "x3": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the upper right corner of the luminaire"
          },
          "y1": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the lower left corner of the luminaire"
          },
          "y2": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the upper left corner of the luminaire"
          },
          "y3": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the upper right corner of the luminaire"
          },
          "z": {
            "format": "double",
            "type": "number",
            "description": "Elevation of Luminaire"
          },
          "BLEBeaconId": {
            "format": "int32",
            "type": "integer",
            "description": "BLE Beacon Identifier"
          },
          "BLEBeaconUUId": {
            "format": "string",
            "description": "BLE Beacon Universal Unique Identifier"
          },
          "floorSpaceCatalog_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaire position to a floor space catalog resource"
          },
          "flagNotes": {
            "type": "string",
            "description": "A place for commissioners to put notes about issues with luminaires that have been flagged as having issues"
          },
          "controlGroup_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaire position to a control group resource"
          },
          "externalWidth": {
            "format": "double",
            "type": "number",
            "description": "External Width (meter)"
          },
          "externalLength": {
            "format": "double",
            "type": "number",
            "description": "External Length (meter)"
          },
          "VLCEnabled": {
            "type": "boolean",
            "description": "VLC Enabled/Disabled Flag"
          },
          "ciCode": {
            "type": "string",
            "description": "Luminaire Model Number"
          },
          "locationDescription": {
            "type": "string",
            "description": "Description of the location of Luminaire within the site"
          },
          "reportingType": {
            "type": "string",
            "description": "Reporting type"
          },
          "luminaireType_ID": {
            "format": "int32",
            "type": "integer",
            "description": "FK to Luminaire Type"
          },
          "luminaireTypeDisplayName": {
            "type": "string",
            "description": "Luminaire Type Name"
          }
        },
        "example": {
          "luminairePositionId": 1,
          "floorSpace_ID": 1,
          "x1": -8.737702,
          "x2": -8.737702,
          "x3": -8.966302,
          "y1": -1.8288,
          "y2": -3.048,
          "y3": -3.048,
          "z": 0,
          "floorSpaceCatalog_ID": 1,
          "flagNotes": "",
          "controlGroup_ID": 1,
          "externalWidth": 2,
          "externalLength": 4,
          "VLCEnabled": true,
          "id": 1,
          "tag": "string",
          "BLEBeaconId": 15615871,
          "ciCode": "000000",
          "locationDescription": "Back Left Corner",
          "reportingType": "cls",
          "luminaireType_ID": "1",
          "luminaireTypeDisplayName": "TestLuminaire"
        }
      }
    }
  },
  "example": {
    "floorSpace": {
      "role_ID": 1,
      "roleName": "Demo Role",
      "floorSpaceMaps": {
        "GTWidth": 0.0050977830783194749,
        "epsg_ID": 3857,
        "displayImageUrl": "https://__ASSET_SA__.blob.core.windows.net/f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1/floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6/map@2x.png",
        "imagePixelWidth": 8250,
        "GTYRotation": 5.0158750156886082E-05,
        "GTXRotation": 5.0158750156886082E-05,
        "floorSpaceWidth": 21.03,
        "GTHeight": -0.0050977830783194749,
        "containerName": "f73e892b-ac6f-4d1e-a92e-880adda8a7a6-1",
        "imagePixelHeight": 5250,
        "floorSpaceLength": 13.38,
        "imageMetersPerPixel": 0.002548,
        "GTX": -9355560.3558281623,
        "GTY": 3985950.8758218605,
        "folderName": "floorspacemaps/fs1/f73e892b-ac6f-4d1e-a92e-880adda8a7a6",
        "displayName": "Demo Floor Space Map",
        "tiledImageUrl": null
      },
      "floorSpaceID": 1,
      "site_ID": 1,
      "floorSpaceName": "Demo floor space",
      "cellWidth": 2,
      "cellLength": 4,
      "floorSpaceWidth": 20,
      "floorSpaceLength": 30,
      "gridXOffset": 0,
      "gridYOffset": 0,
      "mapOffsetX": 0,
      "mapOffsetY": 0,
      "maxMountingHeight": 10,
      "coordinateConversionRule": 0,
      "mapAngleOffsetRadians": null,
      "hasBLEBeacons": true,
      "fixtureType": "BLT",
      "operatingPoint": 100,
      "VLCEnabled": true,
      "floor_ID": 1,
      "GTXRotation": 9.6916E-08,
      "GTYRotation": -8.1282E-08,
      "GTWidth": -1.1056632E-05,
      "GTHeight": -9.24342E-06,
      "GTX": -84.0419236132,
      "GTY": 33.6800256587,
      "GTHeadingOffset": 3.14,
      "GTImageOrigin": "ul",
      "active": true,
      "VLCIDUpperLimit": 2000,
      "mobileFloorSpaceOptions": {
        "thresholdRssi": -80,
        "topBeaconThresholdRssi": 6,
        "accuracyBLE": 3,
        "floorRssiGain": 0,
        "staleBeaconThreshold": 5
      }
    },
    "luminaireTypes": [
      {
        "luminaireTypeID": 1,
        "organization_ID": 1,
        "displayName": "Demo Luminaire",
        "exteriorWidth": 0.6096,
        "exteriorLength": 0.6096,
        "interiorWidth": 0.6096,
        "interiorLength": 0.6096,
        "reportingType": "cls"
      }
    ],
    "luminaireSummary": [
      {
        "vlcID": 1,
        "bleBeaconID": 1,
        "BLEBeaconUUId": "asdf1535",
        "floorSpace_ID": 1,
        "floorSpaceName": "Demo Floor Space",
        "xMeters": -8.737702,
        "yMeters": -1.8288,
        "xFt": 28.666995668,
        "yFt": 6.000000192,
        "width": 2,
        "height": 4,
        "luminaireLabel": 0,
        "flagNotes": "",
        "controlGroup_ID": 1,
        "externalWidth": 2,
        "externalLength": 4,
        "vlcEnabled": true,
        "ciCode": "000000",
        "locationDescription": "Back Left Corner",
        "reportingType": "cls",
        "luminaireType_ID": "1",
        "luminaireTypeDisplayName": "TestLuminaire"
      }
    ]
  }
}

Response 400

Invalid Request.

{
  "msg": "Improper format for call.",
  "requestId": "273e4bb4-3019-42ea-8de9-f2c7853f7fdd",
  "code": "BadRequest"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 401

Not Authorized To Access This Resource.

{
  "msg": "Unauthorized to access this resource.",
  "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
  "code": "Unauthorized"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 404

Resource Not Found.

{
  "msg": "The resource requested was not found.",
  "requestId": "b9ff87b2-3397-45f7-a0b6-25482b0a7898",
  "code": "NotFound"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps"
-H "atr-environment-id: atrdemo01us"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "atr-subscription-key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("atr-environment-id", "atrdemo01us");
            client.DefaultRequestHeaders.Add("atr-partner-id", "");
            client.DefaultRequestHeaders.Add("atr-request-source", "");
            client.DefaultRequestHeaders.Add("atr-subscription-key", "{subscription key}");

            var uri = "https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("atr-environment-id", "atrdemo01us");
            request.setHeader("atr-partner-id", "");
            request.setHeader("atr-request-source", "");
            request.setHeader("atr-subscription-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("atr-environment-id","atrdemo01us");
                xhrObj.setRequestHeader("atr-partner-id","");
                xhrObj.setRequestHeader("atr-request-source","");
                xhrObj.setRequestHeader("atr-subscription-key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"atr-subscription-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'atr-environment-id' => 'atrdemo01us',
    'atr-partner-id' => '',
    'atr-request-source' => '',
    'atr-subscription-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.us.atrius-iot.io/api/v1/admin/floor-spaces/{floorSpaceId}/with-lightsmaps')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['atr-environment-id'] = 'atrdemo01us'
# Request headers
request['atr-partner-id'] = ''
# Request headers
request['atr-request-source'] = ''
# Request headers
request['atr-subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body