Admin Floor Space Maps (v1)

The Floor Space Map API provides access to create, read and update floor space map resources. A floor space can currently only support a single floor space map. Floor space maps can be loaded with optional geotransform information to provide a spatial context to the floor space.

GetFloorSpaceMapsById

Retrieves a single floor space map resource.

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

Floor Space Map 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 map resource.

{
  "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
}
{
  "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
  }
}

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-space-maps/{mapId}"
-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-space-maps/{mapId}?" + 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-space-maps/{mapId}");


            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-space-maps/{mapId}?" + $.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-space-maps/{mapId}";
    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-space-maps/{mapId}');
$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-space-maps/{mapId}?%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-space-maps/{mapId}?%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-space-maps/{mapId}')


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