WebSupervisor API

API change history

Unit info

Returns basic information about the unit

Try it

Request

Request URL

https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info

Request parameters

loginId

string

WSV account you want to access via API
unitGuid

string

Unique unit identifier

Request headers

Authorization

string

Header for token type + access token, i.e. "Bearer asd....fg12"
Comap-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns basic information about the unit

Response values:

name: name of the Unit, same as in Websupervisor. (string)
unitGuid: unique static identification of the Unit. (string)
ownerLoginId: account with owner status configured in the Unit. (string)
applicationType: application type configured in the Unit. (string)
timezone: timezone configured in the Unit. (string)
connection: list of values related to the Unit network connection. (field)
enabled: network connection is enabled/disabled. true/false (boolean)
airGateId: ID of connection trought Airtgate service. (string)
ipAddress: IP address of the Unit network interface. (string)
port: used TCP port. (number)
controllerAddress: Address of controller configured in the Unit. (number)
position: list of values related to the Unit configured position. (field)
positionType: type of configured position of the Unit. (string)
latitude: geographical position - latitude. (string)
longtitude: geographical position - longtitude. (string)

Representations

application/json

{
  "name": "Controller 1",
  "unitGuid": "gensete5ffa1149c0a78b4a5798f8a2e812130",
  "ownerLoginId": "user_1",
  "applicationType": "Rental",
  "timezone": "Europe/Prague",
  "connection": {
    "enabled": true,
    "airGateId": "eC6M9w2",
    "ipAddress": "",
    "port": 0,
    "controllerAddress": 1
  },
  "position": {
    "positionType": "Static",
    "latitude": "50.10694",
    "longitude": "14.45333"
  }
}

400 Bad Request

Response when incorrect unitGuid is provided

Representations

application/json

401 Unauthorized

Response when incorrect or expired token is provided

Representations

application/json

Code samples

@ECHO OFF

curl -v -X GET "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info"
-H "Authorization: "
-H "Comap-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("Authorization", "");
            client.DefaultRequestHeaders.Add("Comap-Key", "{subscription key}");

            var uri = "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info?" + 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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Comap-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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Comap-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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info";
    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:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Comap-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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Comap-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
    'Authorization': '',
    'Comap-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.websupervisor.net')
    conn.request("GET", "/v1.1/{loginId}/units/{unitGuid}/info?%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
    'Authorization': '',
    'Comap-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.websupervisor.net')
    conn.request("GET", "/v1.1/{loginId}/units/{unitGuid}/info?%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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/info')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Comap-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