1. Definitions
2. HTTP Status Codes
3. API Response Types
   1. Success Response
   2. Error Response
4. API Access Area
5. API Environment Classification

Definitions

IoT

Internet of Things

DAPI

Dynamic Application Programming Interface

Tenant

Tenant is an isolated environment configuration done per client. Only the client has access to the Tenant environment.

Portal

Portal gives users the ability to manage and configure edge devices and gateways.

Commander™

The Commander™ is a web application that enables users to visually represent telemetry, manipulate edge telemetry and interact with edge devices or gateways.

URL

Uniform Resource Locator

API

Application Programming Interface

HTTP

Hyper Text Transfer Protocol

HTTPS

Hyper Text Transfer Protocol Secure

SignalR

SignalR is a software library for Microsoft ASP.NET that allows server code to send asynchronous notifications to client-side web applications.

HTTP Status Codes

Http Status codes are issued by a server in response to a client’s request made to the server. Below is a list of commonly used status codes:

API Response Types

Success Response

{
  "result": {
  },
  "messageType": "OK",
  "state": null,
  "sourceMessageID": "d760b76cb4f246e1a0c8a0a3ed7b2ad2"
}

Error Response

{
  "result": null,
  "messageType": "error",
  "errorCode": 1,
  "errorMessage": "",
  "exceptionType": "",
  "state": null,
  "sourceMessageID": "063828e55f2c43189541787b6da2d856"
}

API Access Area

Core Only

Api can only be accessed through the Core url.

Tenant Root Only

Api can only be accessed by the tenant owner through the Tenant url.

Tenant Account Only

Api can only be accessed on account level through the Tenant url.

Tenant Account and Root Only

Api can be accessed by both account level users and tenant owners, but only through the Tenant url.

Core and Tenant

Api can be accessed by both Core and Tenant urls. This includes both account level users and tenant owners.

API Environment Classification