1 of 9

SDK API

OpenWiFi 2.0 SDK

OpenWiFi services follow the OpenAPI 3.0 definition. The complete API is described here: OpenWiFi SDK OpenAPI

Devices

OpenWiFi devices are Access Points or Switches (and other forms in the future), that support the uCentral configuration schema. Devices contact a controller using the uCentral protocol.

Communication

The communication between the controller and the devices use the uCentral protocol. This protocol is defined in this document.

Device Configuration

A device is configured by ingesting a uCentral configuration. That configuration will be provided by the SDK Gateway as a result of a command through the API. Command processing occurs when the device's configuration is older than what is known in the SDK Gateway. The uCentral schema is a JSON document containing parameters to set on a particular device.

SDK Gateway Communication

In order to speak to the Gateway, you must implement a client that uses the OpenAPI definition for the gateway. You can find its definition here. You cannot talk to a device directly.

API Basics

Device `serialNumber`

Throughout the API, the serialNumber of the device is used as the key. The serialNumber is actual the MAC address of the device, without its :. The serialNumber is guaranteed to be unique worldwide. The device uses its serial number to identify itself to the controller.

Device Configuration

The configuration can be supplied when the device is created. After the device is created, the only way to modify the configuration is by using the /device/{serialNumber}/configure endpoint. The Gateway maintains the versioning of the configuration through the use of a uuid. The Gateway maintains that number and will ignore anything your supply. The controller also does minimum validation on the configuration: it must be a valid JSON document and must have a uuid field which will be ignored.

Device Capabilities

Device capabilities are uploaded to the Gateway when the device performs its initial connection. Capabilities tell the Gateway what the device is able to support. The Gateway uses this information to provide a configuration matched to the device type.

Command Queue

The Gateway will send commands to the devices. These commands are kept in a table and are sent at the appropriate time or immediately when the device connects. For example, you could ask a device to change its configuration, however it might be unreachable. Upon next device connection, this configure command will be sent. The list of commands is retrieved using the /commands endpoint.

Commands

Several commands maybe sent to a device: reboot, configure, factory reset, firmware upgrade, LEDs, trace, message request, etc. The API endpoint /device/{serialNumber}/{command} details all the available commands.

Device Specific Collections

For each device, a number of collections are collected and kept in the database. Here's a brief list:

logs: device specific logs are kept. A device amy also send something it wants added into its own logs. crashlogs are a special type of logs created after a device has had a hard crash.
statistics: statistics about the device. This is current la JSON document and will be documented at a later date.
healthchecks: periodically, a device will run a self-test and report its results. These includes anything that maybe going wrong with the current device configuration. A sanity level is associated to the degree of health of the device. 100 meaning a properly operating device.
status: tells you where the device is and how much data is used for protocol communication.

The API is for an operator

This API is meant for an operator who would have to help a subscriber in configuring devices, reboot, manage firmware, etc.

OpenAPI Definitions

OpenWiFi 2.0 SDK

Where is the OpenAPI?

This uses OpenAPI definition 3.0 and can be found here. All endpoints begin with /api/v1.

API Flow

API endpoints are secured with bearer-token authentication using end-point /oauth2. Once you obtain access-token, you will need to pass it in the headers under Authorization: Bearer <place your token here>.

Basic Entities

The API revolves around devices, commands, and default_configurations. To retrieve a list of devices to know what is available and then use the endpoint device to access all device specific information. To retrieve commands and default_configurations follow those endpoints. Most operations rely on the serialNumber of a device. That serialNumber is unique and generated on the device. Serial Number matches the device's MAC address.

devices: The list of all devices in the system. This maybe very large, pagination is recommended.
commands: The list of commands issued by the system. This list could also be large.
default_configurations: A list of default configurations used to supply existing devices.

Relationships

A device is a physical (or potentially logical) entity using the ucentral protocol. Currently, APs and Switches are the only devices used. A device has several attributes. Additionally, other collections are supported for each device:

logs: Specific for a device. Logs originate from the device or associated with the device by some mechanism.
healthchecks: Reports from the device coming periodically after device self tests.
statistics: Periodically produced by the devices and document actual state data from each device.
capabilities: This details the actual data model supported by the device.

The device entry point is also used to query about the status of the device and used to inject certain commands for a specific device. Commands supported for each device:

reboot: This will force the device to reboot.
configure: Configure sends a new configuration to a device.
factory: Forces the device to perform a factory-reset.
upgrade: Forces the device to do a firmware upgrade.
leds: Ask the device to flash its LEDs or turn them on or off.
trace: Performs a remove LAN trace. Once the trace is completed, the produced file may be removed using the file endpoint.
command: Performs a proprietary command. The meaning depends on the device.
request: Request an immediate message of type state or healthcheck.

The file end point is used to retrieve and remove files produced by the Gateway. Currently this is limited to the results of a trace command. The file name will always match the uuid of the command that produced it. If several files are needed, the files will be named uuid, uuid.1, uuid.2, etc.

Dates

All dates should use the format defined in RFC3339. All times are UTC based. Here is an example:

1985-04-12T23:20:50.52Z

Command `when` parameter

Most commands use a when parameter to suggest to the device when to perform the command. This is a suggestion only. The device may decide to perform the command when it is optimal for itself. It maybe busy doing something and decline to do a reboot for several minutes for example. The device may reply with the actual when it will perform the command.

Configuration UUID

The gateway manages the configuration UUID. So if you set a UUID for a configuration, it will be ignored. The gateway uses UUID as versioning. The UUID is unique within a single device. The resulting UUID or a configuration change is returned as part of the configure command.

Security Service

Gateway Service

Firmware Management Service

Provisioning Service

Analytics Service

Radio Resource Management Service

Postman Collection

Here is the current postman collection for testing purposes:

const response = await fetch('https://localhost:16001/api/v1/submfa', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/userPreferences', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/avatar/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "image/jpeg"
    },
    body: JSON.stringify("binary"),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/signup?signupUUID=123e4567-e89b-12d3-a456-426614174000&operation=cancel', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/email', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/sms', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/suboauth2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "support@example.com",
      "password": "support"
    }),
});
const data = await response.json();

{
  "access_token": "text",
  "refresh_token": "text",
  "token_type": "text",
  "username": "text",
  "userMustChangePassword": false,
  "aclTemplate": {
    "aclTemplate": {
      "Read": false,
      "ReadWrite": false,
      "ReadWriteCreate": false,
      "Delete": false,
      "PortalLogin": false
    }
  }
}

const response = await fetch('https://localhost:16001/api/v1/oauth2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "support@example.com",
      "password": "support"
    }),
});
const data = await response.json();

{
  "access_token": "text",
  "refresh_token": "text",
  "token_type": "text",
  "username": "text",
  "userMustChangePassword": false,
  "aclTemplate": {
    "aclTemplate": {
      "Read": false,
      "ReadWrite": false,
      "ReadWriteCreate": false,
      "Delete": false,
      "PortalLogin": false
    }
  }
}

const response = await fetch('https://localhost:16001/api/v1/signup?email=name%40gmail.com&signupUUID=123e4567-e89b-12d3-a456-426614174000', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/user/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/user/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/subuser/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/subuser/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "enableRRM": false,
  "schedule": {
    "cron": "text",
    "algorithms": [
      {
        "name": "text"
      }
    ]
  },
  "enableConfig": false,
  "enableWifiScan": false,
  "location": []
}

const response = await fetch('/api/v1/modifyDeviceApConfig?serial=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('/api/v1/setDeviceApConfig?serial=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('/api/v1/setDeviceZoneConfig?zone=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "networkConfig": {
    "enableRRM": false,
    "schedule": {
      "cron": "text",
      "algorithms": [
        {
          "name": "text"
        }
      ]
    },
    "enableConfig": false,
    "enableWifiScan": false,
    "location": []
  }
}

const response = await fetch('/api/v1/setDeviceNetworkConfig', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16003/api/v1/revisionHistory/{serialNumber}?id=123e4567-e89b-12d3-a456-426614174000', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "history": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "serialNumber": "text",
      "revisionId": "123e4567-e89b-12d3-a456-426614174000",
      "fromRelease": "text",
      "toRelease": "text",
      "commandUUID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "latestId": "text",
  "image": "text",
  "revision": "text",
  "uri": "https://example.com",
  "age": "this is in seconds. a 0 means we cannot determine the age. something like 'unknown' should be shown to the user.",
  "latest": false
}

const response = await fetch('https://localhost:16003/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

{
  "firmwares": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "deviceType": "text",
      "description": "text",
      "revision": "text",
      "uri": "https://example.com",
      "image": "text",
      "firmwareHash": "text",
      "owner": "text",
      "location": "https://example.com",
      "uploader": "text",
      "digest": "text",
      "latest": false,
      "notes": [
        {
          "createdBy": "text",
          "note": "text"
        }
      ]
    }
  ]
}

{
  "ouis": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "revisions": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "deviceTypes": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "status": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "endPoints": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "unknownFirmwares": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "usingLatest": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "totalSecondsOld": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  }
}

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

Retrieve a list of entities.

GEThttps://localhost:16005/api/v1/entity

Query parameters

offsetinteger

Pagination start (starts at 1. If not specified, 1 is assumed)

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: "serial1,serial2,serial3"

countOnlyboolean

return the number of devices

Response

Return a list of elements

Body

one of

entitiesarray of Entity (object)

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

parentstring (uuid)

If empty, then this is the root entity, otherwise this points to a parent entity

childrenarray of string (uuid)

itemsstring (uuid)

venuesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

contactsarray of string (uuid)

The list of UUID of the contacts for the entity

itemsstring (uuid)

locationsarray of string (uuid)

The list of UUID of the locations associated with thit entiry

itemsstring (uuid)

managementPolicystring (uuid)

deviceConfigurationstring (uuid)

devicesarray of string (uuid)

itemsstring (uuid)

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

variablesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

mapsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

deviceRulesDeviceRules (object)

rcOnlyenum

yesnoinherit

rrmenum

yesnoinherit

firmwareUpgradeenum

yesnoinherit

sourceIPStringList (object)

listarray of string

itemsstring

defaultEntityboolean

typeenum

normalsubscriber

Request

Response

Retrieve a list of venues.

GEThttps://localhost:16005/api/v1/venue

Query parameters

entitystring (uuid)

venuestring (uuid)

unassignedboolean

deviceTypestring

offsetinteger

Pagination start (starts at 1. If not specified, 1 is assumed)

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

filterstring

Filter the results

selectstring

Supply a list of Venues comma separated

Example: "serial1,serial2,serial3"

countOnlyboolean

return the number of devices

getDevicesboolean

return the devices under a venue

getChildrenboolean

return the devices under a venue and its children. Must select getDevices=true as well.

Response

Return a list of venues.

Body

one of

venuesarray of Venue (object)

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

itemsstring (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

itemsstring (uuid)

topologyDiGraph (array of DiGraphEntry (object))

parentstring (uuid)

childstring (uuid)

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

itemsstring (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

rcOnlyenum

yesnoinherit

rrmenum

yesnoinherit

firmwareUpgradeenum

yesnoinherit

sourceIPStringList (object)

listarray of string

itemsstring

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

variablesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

mapsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

itemsstring (uuid)

Request

Response

Modify a specific venue.

PUThttps://localhost:16005/api/v1/venue/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

updateAllDevicesboolean

rebootAllDevicesboolean

testUpdateOnlyboolean

upgradeAllDevicesboolean

Body

Information used to modify the new venue

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

itemsstring (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

itemsstring (uuid)

topologyDiGraph (array of DiGraphEntry (object))

parentstring (uuid)

childstring (uuid)

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

itemsstring (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

rcOnlyenum

yesnoinherit

rrmenum

yesnoinherit

firmwareUpgradeenum

yesnoinherit

sourceIPStringList (object)

listarray of string

itemsstring

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

variablesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

mapsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

itemsstring (uuid)

Response

Return venue information or list of serial number updated

Body

one of

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

itemsstring (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

itemsstring (uuid)

topologyDiGraph (array of DiGraphEntry (object))

parentstring (uuid)

childstring (uuid)

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

itemsstring (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

rcOnlyenum

yesnoinherit

rrmenum

yesnoinherit

firmwareUpgradeenum

yesnoinherit

sourceIPStringList (object)

listarray of string

itemsstring

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

variablesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

mapsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

itemsstring (uuid)

Request

Response

Create a specific venue.

POSThttps://localhost:16005/api/v1/venue/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

createObjectsobject

objectsarray of one of

itemsone of

locationLocation (object)

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

typeenum

SERVICEEQUIPMENTAUTOMANUALSPECIALUNKNOWNCORPORATE

buildingNamestring

addressLinesarray of string

itemsstring

citystring

statestring

postalstring

countrystring

phonesarray of string

itemsstring

mobilesarray of string

itemsstring

inUsearray of string (uuid)

itemsstring (uuid)

Example: "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"

entitystring (uuid)

managementPolicystring (uuid)

geoCodestring

Body

Information used to create the new venue

allOfObjectInfo (object)

idstring (uuid)

namestring

descriptionstring

notesarray of NoteInfo (object)

createdinteger (int64)

createdBystring

notestring

createdinteger (int64)

modifiedinteger (int64)

tagsarray of integer (int64)

itemsinteger (int64)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

itemsstring (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

itemsstring (uuid)

topologyDiGraph (array of DiGraphEntry (object))

parentstring (uuid)

childstring (uuid)

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

itemsstring (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

rcOnlyenum

yesnoinherit

rrmenum

yesnoinherit

firmwareUpgradeenum

yesnoinherit

sourceIPStringList (object)

listarray of string

itemsstring

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

variablesarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

mapsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

itemsstring (uuid)

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

itemsstring (uuid)

Response

Request

Response

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory?macsOnly=false&venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "monitorSubVenues": false
    }
  ]
}

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16009/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/radiusProxyConfig', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/ping', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/blacklist/{serialNumber}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/eventqueue', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/default_configuration/{name}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "UUID": "123e4567-e89b-12d3-a456-426614174000",
  "command": "text",
  "details": "text",
  "serialNumber": "text",
  "errorText": "text",
  "results": "text",
  "submittedBy": "text",
  "status": "text",
  "attachType": "text"
}

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/reboot', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/factory', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "commands": [
    {
      "UUID": "123e4567-e89b-12d3-a456-426614174000",
      "command": "text",
      "details": "text",
      "serialNumber": "text",
      "errorText": "text",
      "results": "text",
      "submittedBy": "text",
      "status": "text",
      "attachType": "text"
    }
  ]
}

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/command', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/upgrade', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/configure', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/trace', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/leds', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/telemetry', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/script', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceType": "AP"
    }),
});
const data = await response.json();

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceType": "AP"
    }),
});
const data = await response.json();

{
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "serialNumber": "text",
  "deviceType": "AP",
  "macAddress": "text",
  "manufacturer": "text",
  "configuration": "text",
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ],
  "firmware": "text",
  "devicePassword": "text",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "locale": "text"
}

const response = await fetch('https://localhost:16001/api/v1/device/{serialNumber}/wifiscan', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serialNumber": "text"
    }),
});
const data = await response.json();

{
  "devices": [
    {
      "owner": "123e4567-e89b-12d3-a456-426614174000",
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "serialNumber": "text",
      "deviceType": "AP",
      "macAddress": "text",
      "manufacturer": "text",
      "configuration": "text",
      "notes": [
        {
          "createdBy": "text",
          "note": "text"
        }
      ],
      "firmware": "text",
      "devicePassword": "text",
      "subscriber": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "locale": "text"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/managementPolicy/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/map/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/managementRole/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/managementRole/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/serviceClass/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "policies": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "entries": [
        {
          "users": [
            "text"
          ],
          "resources": [
            "text"
          ],
          "access": [
            "NOACCESS"
          ],
          "policy": "text"
        }
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "list": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "data": "text",
      "visibility": "private",
      "creator": "123e4567-e89b-12d3-a456-426614174000",
      "access": {
        "list": [
          {
            "users": {
              "list": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "roles": {
              "list": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "access": "none"
          }
        ]
      }
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "email": "name@gmail.com",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "operatorId": "123e4567-e89b-12d3-a456-426614174000",
  "macAddress": "text",
  "serialNumber": "text",
  "status": "text",
  "registrationId": "text"
}

const response = await fetch('https://localhost:16005/api/v1/serviceClass/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "roles": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/operatorLocation/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/operatorLocation/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/serviceClass?operatorId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "serviceClasses": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "operatorId": "123e4567-e89b-12d3-a456-426614174000",
      "cost": 0,
      "currency": "text",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "period": "hourly",
      "billingCode": "text",
      "variables": [
        {
          "type": "integer",
          "prefix": "text",
          "value": "text"
        }
      ],
      "defaultService": false
    }
  ]
}

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "type": "SERVICE",
  "buildingName": "text",
  "addressLines": [
    "text"
  ],
  "city": "text",
  "state": "text",
  "postal": "text",
  "country": "text",
  "phones": [
    "text"
  ],
  "mobiles": [
    "text"
  ],
  "inUse": [
    "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "geoCode": "text"
}

const response = await fetch('https://localhost:16005/api/v1/signup?signupUUID=123e4567-e89b-12d3-a456-426614174000&operation=cancel', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "operators": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "variables": [
        {
          "type": "integer",
          "prefix": "text",
          "value": "text"
        }
      ],
      "defaultOperator": false,
      "deviceRules": {
        "rcOnly": "yes",
        "rrm": "yes",
        "firmwareUpgrade": "yes"
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "managementRoles": {
        "roles": [
          {
            "allOf": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "description": "text",
              "notes": [
                {
                  "createdBy": "text",
                  "note": "text"
                }
              ],
              "tags": []
            },
            "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
            "users": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "inUse": [
              "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
            ],
            "entity": "123e4567-e89b-12d3-a456-426614174000",
            "venue": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "sourceIP": {
        "list": [
          "text"
        ]
      },
      "registrationId": "text"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/operator/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/operatorContact/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/operatorContact/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "type": "SUBSCRIBER",
  "title": "text",
  "salutation": "text",
  "firstname": "text",
  "lastname": "text",
  "initials": "text",
  "visual": "text",
  "phones": [
    "text"
  ],
  "mobiles": [
    "text"
  ],
  "primaryEmail": "text",
  "secondaryEmail": "text",
  "accessPIN": "text",
  "inUse": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
}

const response = await fetch('https://localhost:16005/api/v1/operator/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "entries": [
    {
      "users": [
        "text"
      ],
      "resources": [
        "text"
      ],
      "access": [
        "NOACCESS"
      ],
      "policy": "text"
    }
  ],
  "inUse": [
    "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000"
}

const response = await fetch('https://localhost:16005/api/v1/location/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/location/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/contact/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/contact/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "data": "text",
  "visibility": "private",
  "creator": "123e4567-e89b-12d3-a456-426614174000",
  "access": {
    "list": [
      {
        "users": {
          "list": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "roles": {
          "list": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "access": "none"
      }
    ]
  }
}

{
  "configurations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "deviceTypes": [
        "text"
      ],
      "configuration": [
        {
          "name": "text",
          "description": "text",
          "configuration": "text"
        }
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "inUse": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "subscriberOnly": false,
      "deviceRules": {
        "rcOnly": "yes",
        "rrm": "yes",
        "firmwareUpgrade": "yes"
      },
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "subscriber": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inUse": [
    "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000"
}

const response = await fetch('https://localhost:16005/api/v1/operatorLocation?operatorId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "locations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "type": "SERVICE",
      "buildingName": "text",
      "addressLines": [
        "text"
      ],
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "operatorId": "123e4567-e89b-12d3-a456-426614174000",
      "subscriberDeviceId": "123e4567-e89b-12d3-a456-426614174000",
      "geoCode": "text"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/managementPolicy/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/inventory/{serialNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/inventory/{serialNumber}?removeSubscriber=123e4567-e89b-12d3-a456-426614174000', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "serialNumber": "text",
  "deviceType": "text",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "qrCode": "text",
  "geoCode": "text",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "contact": "123e4567-e89b-12d3-a456-426614174000",
  "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
  "deviceRules": {
    "rcOnly": "yes",
    "rrm": "yes",
    "firmwareUpgrade": "yes"
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "devClass": "any",
  "locale": "text"
}

const response = await fetch('https://localhost:16005/api/v1/signup?email=name%40gmail.com&macAddress=text&registrationId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/operatorContact?operatorId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "contacts": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "type": "SUBSCRIBER",
      "title": "text",
      "salutation": "text",
      "firstname": "text",
      "lastname": "text",
      "initials": "text",
      "visual": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "primaryEmail": "text",
      "secondaryEmail": "text",
      "accessPIN": "text",
      "operatorId": "123e4567-e89b-12d3-a456-426614174000",
      "subscriberDeviceId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/configuration/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "locations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "type": "SERVICE",
      "buildingName": "text",
      "addressLines": [
        "text"
      ],
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "geoCode": "text"
    }
  ]
}

{
  "contacts": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "type": "SUBSCRIBER",
      "title": "text",
      "salutation": "text",
      "firstname": "text",
      "lastname": "text",
      "initials": "text",
      "visual": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "primaryEmail": "text",
      "secondaryEmail": "text",
      "accessPIN": "text",
      "inUse": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/configuration/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/map/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "deviceTypes": [
    "text"
  ],
  "configuration": [
    {
      "name": "text",
      "description": "text",
      "configuration": "text"
    }
  ],
  "variables": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inUse": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "subscriberOnly": false,
  "deviceRules": {
    "rcOnly": "yes",
    "rrm": "yes",
    "firmwareUpgrade": "yes"
  },
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000"
}

const response = await fetch('https://localhost:16005/api/v1/subscriberDevice?operatorId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "subscriberDevices": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "serialNumber": "text",
      "realMacAddress": "text",
      "operatorId": "123e4567-e89b-12d3-a456-426614174000",
      "deviceType": "text",
      "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
      "qrCode": "text",
      "geoCode": "text",
      "location": {
        "type": "SERVICE",
        "buildingName": "text",
        "addressLines": [
          "text"
        ],
        "city": "text",
        "state": "text",
        "postal": "text",
        "country": "text",
        "phones": [
          "text"
        ],
        "mobiles": [
          "text"
        ],
        "geoCode": "text"
      },
      "contact": {
        "type": "SUBSCRIBER",
        "title": "text",
        "salutation": "text",
        "firstname": "text",
        "lastname": "text",
        "initials": "text",
        "visual": "text",
        "phones": [
          "text"
        ],
        "mobiles": [
          "text"
        ],
        "primaryEmail": "text",
        "secondaryEmail": "text",
        "accessPIN": "text"
      },
      "deviceRules": {
        "rcOnly": "yes",
        "rrm": "yes",
        "firmwareUpgrade": "yes"
      },
      "state": "text",
      "locale": "text",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "suspended": false,
      "configuration": [
        {
          "name": "text",
          "description": "text",
          "configuration": "text"
        }
      ],
      "serviceClass": "123e4567-e89b-12d3-a456-426614174000",
      "billingCode": "text"
    }
  ]
}

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "serialNumber": "text",
  "deviceType": "text",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "qrCode": "text",
  "geoCode": "text",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "contact": "123e4567-e89b-12d3-a456-426614174000",
  "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
  "deviceRules": {
    "rcOnly": "yes",
    "rrm": "yes",
    "firmwareUpgrade": "yes"
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "devClass": "any",
  "locale": "text"
}

const response = await fetch('https://localhost:16005/api/v1/subscriberDevice/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/subscriberDevice/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "entities": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "children": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "venues": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "locations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
      "devices": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementPolicies": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementRoles": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "maps": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "configurations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "deviceRules": {
        "rcOnly": "yes",
        "rrm": "yes",
        "firmwareUpgrade": "yes"
      },
      "sourceIP": {
        "list": [
          "text"
        ]
      },
      "defaultEntity": false,
      "type": "normal"
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/entity/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://localhost:16005/api/v1/entity/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "venues": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": []
      },
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "children": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "devices": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "topology": [
        {
          "parent": "123e4567-e89b-12d3-a456-426614174000",
          "child": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "design": "text",
      "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "deviceRules": {
        "rcOnly": "yes",
        "rrm": "yes",
        "firmwareUpgrade": "yes"
      },
      "sourceIP": {
        "list": [
          "text"
        ]
      },
      "managementPolicies": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementRoles": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "maps": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "configurations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "boards": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

const response = await fetch('https://localhost:16005/api/v1/venue/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "parent": "123e4567-e89b-12d3-a456-426614174000",
  "children": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "devices": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "topology": [
    {
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "child": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "design": "text",
  "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
  "contacts": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "deviceRules": {
    "rcOnly": "yes",
    "rrm": "yes",
    "firmwareUpgrade": "yes"
  },
  "sourceIP": {
    "list": [
      "text"
    ]
  },
  "managementPolicies": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "managementRoles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "variables": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "maps": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "configurations": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "boards": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

const response = await fetch('https://localhost:16005/api/v1/venue/{uuid}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

SDK API

Devices

Communication

Device Configuration

SDK Gateway Communication

API Basics

Device serialNumber

Device Configuration

Device Capabilities

Command Queue

Commands

Device Specific Collections

The API is for an operator

OpenAPI Definitions

Where is the OpenAPI?

API Flow

Basic Entities

Relationships

Dates

Command when parameter

Configuration UUID

Security Service

Gateway Service

Firmware Management Service

Provisioning Service

Analytics Service

Radio Resource Management Service

Postman Collection

OpenAPI Definitions

Where is the OpenAPI?

API Flow

Basic Entities

Relationships

Dates

Command when parameter

Configuration UUID

SDK API

Devices

Communication

Device Configuration

SDK Gateway Communication

API Basics

Device serialNumber

Device Configuration

Device Capabilities

Command Queue

Commands

Device Specific Collections

The API is for an operator

Firmware Management Service

Returns a list of firmwares.

Returns a Firmware

Create A New firmware

Update A New firmware

Delete some Firmware

List all the defined device revision history

Delete specific hostory elements for a device

Calculate how old a version of firmware is.

Get a list of connected devices and some values.

Get status of a connected device.

get an analysis of the existing devices we know about.

receive a repor on a single decide

Retrieve different values from the running service.

Perform some system wide commands

Gateway Service

Delete some commands

Delete a specific command.

Retrieve the lists of all default configurations.

Retrieve a default configuration.

Delete a default default configuration

Delete a single device.

Delete some device logs.

Delete some device health checks.

Get the latest capabilities for a given device.

Delete the capabilities for a given device.

Get the latest statistics for a given device.

Configure a device.

Get a list of OUIs.

Get a file from the upload directory.

Delete a file from the upload directory.

Device `serialNumber`

Command `when` parameter

Command `when` parameter

Device `serialNumber`