Provisioning Service

Retrieve a list of entities.

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

Query parameters

Response

200400403404

Return a list of elements

Body

application/json

one of

EntityList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/entity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "entities": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific entity.

GEThttps://localhost:16005/api/v1/entity/{uuid}

Path parameters

uuid*string (uuid)

Example: "When looking for the root entity, the uuid 0000-0000-0000 must be entered."

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/entity/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a specific entity.

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

Path parameters

uuid*string (uuid)

Example: "When creating the root entity, the uuid 0000-0000-0000 must be entered. When creating a non-root entity, uuid must be 1"

Body

application/json

Information used to create the new entity

allOfObjectInfo (object)

parentstring (uuid)

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

childrenarray of string (uuid)

venuesarray of string (uuid)

The list of UUID of the venues for this entity

contactsarray of string (uuid)

The list of UUID of the contacts for the entity

locationsarray of string (uuid)

The list of UUID of the locations associated with thit entiry

managementPolicystring (uuid)

deviceConfigurationstring (uuid)

devicesarray of string (uuid)

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

variablesarray of string (uuid)

The list of UUID of the venues for this entity

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

mapsarray of string (uuid)

The list of UUID of the venues for this entity

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

deviceRulesDeviceRules (object)

sourceIPStringList (object)

defaultEntityboolean

typeenum

normalsubscriber

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific entity.

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

Path parameters

uuid*string (uuid)

Example: "When modifying the root entity, the uuid 0000-0000-0000 must be entered."

Body

application/json

Information used to modify the new entity

allOfObjectInfo (object)

parentstring (uuid)

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

childrenarray of string (uuid)

venuesarray of string (uuid)

The list of UUID of the venues for this entity

contactsarray of string (uuid)

The list of UUID of the contacts for the entity

locationsarray of string (uuid)

The list of UUID of the locations associated with thit entiry

managementPolicystring (uuid)

deviceConfigurationstring (uuid)

devicesarray of string (uuid)

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

variablesarray of string (uuid)

The list of UUID of the venues for this entity

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

mapsarray of string (uuid)

The list of UUID of the venues for this entity

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

deviceRulesDeviceRules (object)

sourceIPStringList (object)

defaultEntityboolean

typeenum

normalsubscriber

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific entity.

DELETEhttps://localhost:16005/api/v1/entity/{uuid}

Path parameters

uuid*string (uuid)

Example: "The root entity cannot be deleted."

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/entity/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve a list of contacts.

GEThttps://localhost:16005/api/v1/contact

Query parameters

Response

200400403404

Return a list of contacts

Body

application/json

one of

ContactList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/contact', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "contacts": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific contact.

GEThttps://localhost:16005/api/v1/contact/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

200400403404

Success

Body

application/json

one of

Contact (object)ExpandedUseEntryMapList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/contact/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Create a specific entity.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new entity

allOfObjectInfo (object)

typeenum

SUBSCRIBERUSERINSTALLERCSRMANAGERBUSINESSOWNERTECHNICIANCORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesarray of string

mobilesarray of string

primaryEmailstring

secondaryEmailstring

accessPINstring

inUsearray of string (uuid)

entitystring (uuid)

managementPolicystring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific contact.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify the new entity

allOfObjectInfo (object)

typeenum

SUBSCRIBERUSERINSTALLERCSRMANAGERBUSINESSOWNERTECHNICIANCORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesarray of string

mobilesarray of string

primaryEmailstring

secondaryEmailstring

accessPINstring

inUsearray of string (uuid)

entitystring (uuid)

managementPolicystring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific contact.

DELETEhttps://localhost:16005/api/v1/contact/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

204400403404

The requested operation was performed.

Body

application/json

Operationstring

Detailsstring

Codeinteger

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/contact/{uuid}?force=false', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 0
}

Retrieve a list of locations.

GEThttps://localhost:16005/api/v1/location

Query parameters

Response

200400403404

Return a list of Locations

Body

application/json

one of

LocationList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/location', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "locations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific location.

GEThttps://localhost:16005/api/v1/location/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

200400403404

Success

Body

application/json

one of

Location (object)ExpandedUseEntryMapList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/location/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Create a specific location.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new location

allOfObjectInfo (object)

typeenum

SERVICEEQUIPMENTAUTOMANUALSPECIALUNKNOWNCORPORATE

buildingNamestring

addressLinesarray of string

citystring

statestring

postalstring

countrystring

phonesarray of string

mobilesarray of string

inUsearray of string (uuid)

entitystring (uuid)

managementPolicystring (uuid)

geoCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific location.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify the new location

allOfObjectInfo (object)

typeenum

SERVICEEQUIPMENTAUTOMANUALSPECIALUNKNOWNCORPORATE

buildingNamestring

addressLinesarray of string

citystring

statestring

postalstring

countrystring

phonesarray of string

mobilesarray of string

inUsearray of string (uuid)

entitystring (uuid)

managementPolicystring (uuid)

geoCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific location.

DELETEhttps://localhost:16005/api/v1/location/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/location/{uuid}?force=false', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": 0
}

Retrieve a list of inventory.

GEThttps://localhost:16005/api/v1/inventory

Query parameters

Response

200400403404

Return a list of elements

Body

application/json

one of

SerialNumberList (object)InventoryTagList (object)CountAnswer (object)StringList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/inventory', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "serialNumbers": [
    "text"
  ]
}

Retrieve a specific inventory tag.

GEThttps://localhost:16005/api/v1/inventory/{serialNumber}

Path parameters

serialNumber*string (uuid)

Query parameters

Response

200400403404

Succesful retrieve configuratiopn or part of the configuration

Body

application/json

one of

InventoryTag (object)FirmwareOptions (object)InventoryConfigApplyResult (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/inventory/{serialNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Create a specific Inventory.

POSThttps://localhost:16005/api/v1/inventory/{serialNumber}

Path parameters

serialNumber*string (uuid)

Body

application/json

Information used to create the new entity

allOfObjectInfo (object)

serialNumberstring

deviceTypestring

venuestring (uuid)

entitystring (uuid)

subscriberstring (uuid)

qrCodestring

geoCodestring

locationstring (uuid)

contactstring (uuid)

deviceConfigurationstring (uuid)

deviceRulesDeviceRules (object)

managementPolicystring (uuid)

statestring

devClassenum

anyvenueentitysubscriber

localestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific inventory.

PUThttps://localhost:16005/api/v1/inventory/{serialNumber}

Path parameters

serialNumber*string (uuid)

Query parameters

Body

application/json

Information used to modify the new entity

allOfObjectInfo (object)

serialNumberstring

deviceTypestring

venuestring (uuid)

entitystring (uuid)

subscriberstring (uuid)

qrCodestring

geoCodestring

locationstring (uuid)

contactstring (uuid)

deviceConfigurationstring (uuid)

deviceRulesDeviceRules (object)

managementPolicystring (uuid)

statestring

devClassenum

anyvenueentitysubscriber

localestring

Response

200400403404

success

Body

application/json

allOfObjectInfo (object)

serialNumberstring

deviceTypestring

venuestring (uuid)

entitystring (uuid)

subscriberstring (uuid)

qrCodestring

geoCodestring

locationstring (uuid)

contactstring (uuid)

deviceConfigurationstring (uuid)

deviceRulesDeviceRules (object)

managementPolicystring (uuid)

statestring

devClassenum

anyvenueentitysubscriber

localestring

Request

JavaScriptCurlPythonHTTP

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();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Delete a specific inventory.

DELETEhttps://localhost:16005/api/v1/inventory/{serialNumber}

Path parameters

serialNumber*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/inventory/{serialNumber}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

403

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Retrieve a list of venues.

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

Query parameters

Response

200400403404

Return a list of venues.

Body

application/json

one of

VenueList (object)CountAnswer (object)VenueDeviceList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/venue', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "venues": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
      ]
    }
  ]
}

Retrieve a specific venue.

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

Path parameters

uuid*string (uuid)

Response

200403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/venue/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a specific venue.

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

Path parameters

uuid*string (uuid)

Query parameters

Body

application/json

Information used to create the new venue

allOfObjectInfo (object)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

topologyDiGraph (array of DiGraphEntry (object))

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

sourceIPStringList (object)

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

variablesarray of string (uuid)

The list of UUID of the venues for this entity

mapsarray of string (uuid)

The list of UUID of the venues for this entity

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

Response

200403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific venue.

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

Path parameters

uuid*string (uuid)

Query parameters

Body

application/json

Information used to modify the new venue

allOfObjectInfo (object)

entitystring (uuid)

parentstring (uuid)

childrenarray of string (uuid)

managementPolicystring (uuid)

devicesarray of string (uuid)

topologyDiGraph (array of DiGraphEntry (object))

designstring

deviceConfigurationstring (uuid)

contactsarray of string (uuid)

locationstring (uuid)

deviceRulesDeviceRules (object)

sourceIPStringList (object)

managementPoliciesarray of string (uuid)

The list of UUID of the venues for this entity

managementRolesarray of string (uuid)

The list of UUID of the venues for this entity

variablesarray of string (uuid)

The list of UUID of the venues for this entity

mapsarray of string (uuid)

The list of UUID of the venues for this entity

configurationsarray of string (uuid)

The list of UUID of the venues for this entity

boardsarray of string (uuid)

The list of OWAnalytics Boards created for this venue

Response

200400403404

Return venue information or list of serial number updated

Body

application/json

one of

Venue (object)SerialNumberList (object)

Request

JavaScriptCurlPythonHTTP

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();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
  ]
}

Delete a specific venue.

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

Path parameters

uuid*string (uuid)

Example: "The root entity cannot be deleted."

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/venue/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve the list of maps

GEThttps://localhost:16005/api/v1/map

Query parameters

Response

200400403404

Return a list of Venues

Body

application/json

listarray of Map (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/map', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "list": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
          }
        ]
      }
    }
  ]
}

Retrieve a specific map.

GEThttps://localhost:16005/api/v1/map/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Successfull retrieval of a map

Body

application/json

allOfObjectInfo (object)

entitystring (uuid)

venuestring (uuid)

managementPolicystring (uuid)

datastring

visibilityenum

privatepublicselect

creatorstring (uuid)

accessObjectACLList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/map/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
      }
    ]
  }
}

Create a specific map.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new policy

allOfObjectInfo (object)

entitystring (uuid)

venuestring (uuid)

managementPolicystring (uuid)

datastring

visibilityenum

privatepublicselect

creatorstring (uuid)

accessObjectACLList (object)

Response

200403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific map.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify a map

allOfObjectInfo (object)

entitystring (uuid)

venuestring (uuid)

managementPolicystring (uuid)

datastring

visibilityenum

privatepublicselect

creatorstring (uuid)

accessObjectACLList (object)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific map.

DELETEhttps://localhost:16005/api/v1/map/{uuid}

Path parameters

uuid*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/map/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Get a list of policies.

GEThttps://localhost:16005/api/v1/managementPolicy

Query parameters

Response

200400403404

Return a list of Venues

Body

application/json

one of

ManagementPolicyList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementPolicy', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "policies": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific policy.

GEThttps://localhost:16005/api/v1/managementPolicy/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

200400403404

Succesful retrieve a management policy

Body

application/json

one of

ManagementPolicy (object)ExpandedUseEntryMapList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementPolicy/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Create a specific policy.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new policy

allOfObjectInfo (object)

entriesarray of ManagementPolicyEntry (object)

inUsearray of string (uuid)

entitystring (uuid)

venuestring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific policy.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify the new policy.

allOfObjectInfo (object)

entriesarray of ManagementPolicyEntry (object)

inUsearray of string (uuid)

entitystring (uuid)

venuestring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific policy.

DELETEhttps://localhost:16005/api/v1/managementPolicy/{uuid}

Path parameters

uuid*string (uuid)

Example: "The root entity cannot be deleted."

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementPolicy/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve a list of management roles.

GEThttps://localhost:16005/api/v1/managementRole

Query parameters

Response

200400403404

Return a list of elements

Body

application/json

one of

ManagementRoleList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementRole', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "roles": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific management role.

GEThttps://localhost:16005/api/v1/managementRole/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

200400403404

Success

Body

application/json

one of

ManagementRole (object)ExpandedUseEntryMapList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementRole/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "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"
}

Create a specific management role.

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

Path parameters

uuid*string (uuid)

Example: "during creation, must be set to 1. The real uuid will be returned in the created object"

Body

application/json

Information used to create management role

allOfObjectInfo (object)

managementPolicystring (uuid)

usersarray of string (uuid)

inUsearray of string (uuid)

entitystring (uuid)

venuestring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific management role.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify management role

allOfObjectInfo (object)

managementPolicystring (uuid)

usersarray of string (uuid)

inUsearray of string (uuid)

entitystring (uuid)

venuestring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific management role.

DELETEhttps://localhost:16005/api/v1/managementRole/{uuid}

Path parameters

uuid*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/managementRole/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve a list of configurations.

GEThttps://localhost:16005/api/v1/configuration

Query parameters

Response

200400403404

Return a list of elements

Body

application/json

one of

DeviceConfigurationList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/configuration', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "configurations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "deviceTypes": [
        "text"
      ],
      "configuration": [
        {
          "name": "text",
          "description": "text",
          "weight": 0,
          "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"
    }
  ]
}

Retrieve a specific configuration.

GEThttps://localhost:16005/api/v1/configuration/{uuid}

Path parameters

uuid*string (uuid)

Example: "When looking for the root entity, the uuid 0000-0000-0000 must be entered."

Query parameters

Response

200400403404

Success

Body

application/json

one of

DeviceConfiguration (object)ExpandedUseEntryMapList (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/configuration/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "deviceTypes": [
    "text"
  ],
  "configuration": [
    {
      "name": "text",
      "description": "text",
      "weight": 0,
      "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"
}

Create a specific configuration.

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

Path parameters

uuid*string (uuid)

Example: "When creating the root entity, the uuid 0000-0000-0000 must be entered. When creating a non-root entity, uuid must be 1"

Query parameters

Body

application/json

Information used to create the new entity

allOfObjectInfo (object)

managementPolicystring (uuid)

deviceTypesarray of string

configurationarray of DeviceConfigurationElement (object)

variablesarray of string (uuid)

inUsearray of string (uuid)

subscriberOnlyboolean

deviceRulesDeviceRules (object)

venuestring (uuid)

entitystring (uuid)

subscriberstring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific configuration.

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

Path parameters

uuid*string (uuid)

Example: "When modifying the root entity, the uuid 0000-0000-0000 must be entered."

Body

application/json

Information used to modify the new entity

allOfObjectInfo (object)

managementPolicystring (uuid)

deviceTypesarray of string

configurationarray of DeviceConfigurationElement (object)

variablesarray of string (uuid)

inUsearray of string (uuid)

subscriberOnlyboolean

deviceRulesDeviceRules (object)

venuestring (uuid)

entitystring (uuid)

subscriberstring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific configuration.

DELETEhttps://localhost:16005/api/v1/configuration/{uuid}

Path parameters

uuid*string (uuid)

Example: "The root entity cannot be deleted."

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/configuration/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the country code for an IP address

GEThttps://localhost:16005/api/v1/iptocountry

Query parameters

Response

200400403404

List of country codes.

Body

application/json

enabledboolean

countryCodesarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "enabled": false,
  "countryCodes": [
    "text"
  ]
}

This call allows someone to get the status of a signup.

GEThttps://localhost:16005/api/v1/signup

Query parameters

Response

200400403404

Successfull completion

Body

application/json

one of

SignupEntry (object)Dashboard (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/signup', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 0,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 0,
    "modified": 0,
    "tags": [
      0
    ]
  },
  "email": "[e-mail]",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "operatorId": "123e4567-e89b-12d3-a456-426614174000",
  "macAddress": "text",
  "serialNumber": "text",
  "created": 0,
  "completed": 0,
  "error": 0,
  "status": "text",
  "statusCode": 0,
  "registrationId": "text"
}

This call allows a new subscriber to register themselves and their devices.

POSThttps://localhost:16005/api/v1/signup

Query parameters

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

modify the signup command in play

PUThttps://localhost:16005/api/v1/signup

Query parameters

Body

application/json

reasonstring

timeinteger (int64)

errorCodeinteger (int32)

statusstring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

This call allows someone to delete a specific signUp or all signups according to serialNumber of email address

DELETEhttps://localhost:16005/api/v1/signup

Query parameters

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/signup', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve lists of control blocks

GEThttps://localhost:16005/api/v1/variable

Query parameters

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/variable', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve the list of currently configured operators

GEThttps://localhost:16005/api/v1/operator

Query parameters

Response

200400403404

Successfully retrieved operator list

Body

application/json

one of

OperatorList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operator', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "operators": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "variables": [
        {
          "type": "integer",
          "weight": 0,
          "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": [
                {
                  "created": 0,
                  "createdBy": "text",
                  "note": "text"
                }
              ],
              "created": 0,
              "modified": 0,
              "tags": [
                0
              ]
            },
            "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"
    }
  ]
}

Retrieve an operator

GEThttps://localhost:16005/api/v1/operator/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operator/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a new operator

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

Path parameters

uuid*string (uuid)

Example: "should be set to 0 when creating a new operator"

Body

application/json

allOfObjectInfo (object)

variablesarray of Variable (object)

defaultOperatorboolean

deviceRulesDeviceRules (object)

managementPolicystring (uuid)

managementRolesManagementRoleList (object)

sourceIPStringList (object)

registrationIdstring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Update an existing operator

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

Path parameters

uuid*string (uuid)

Body

application/json

allOfObjectInfo (object)

variablesarray of Variable (object)

defaultOperatorboolean

deviceRulesDeviceRules (object)

managementPolicystring (uuid)

managementRolesManagementRoleList (object)

sourceIPStringList (object)

registrationIdstring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete an operator

DELETEhttps://localhost:16005/api/v1/operator/{uuid}

Path parameters

uuid*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operator/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve the list of currently configured service class

GEThttps://localhost:16005/api/v1/serviceClass

Query parameters

Response

200400403404

Successfully retrieved operator list

Body

application/json

one of

ServiceClassList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

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

Retrieve a service class

GEThttps://localhost:16005/api/v1/serviceClass/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/serviceClass/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a service class

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

Path parameters

uuid*string (uuid)

Example: "should be set to 0 when creating a new operator"

Body

application/json

allOfObjectInfo (object)

operatorIdstring (uuid)

costnumber

currencystring

managementPolicystring (uuid)

periodenum

hourlydailymonthlyyearlyquarterlylifetimecustom1custom2custom3custom4

billingCodestring

variablesarray of Variable (object)

defaultServiceboolean

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Update a service class

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

Path parameters

uuid*string (uuid)

Body

application/json

allOfObjectInfo (object)

operatorIdstring (uuid)

costnumber

currencystring

managementPolicystring (uuid)

periodenum

hourlydailymonthlyyearlyquarterlylifetimecustom1custom2custom3custom4

billingCodestring

variablesarray of Variable (object)

defaultServiceboolean

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a service class

DELETEhttps://localhost:16005/api/v1/serviceClass/{uuid}

Path parameters

uuid*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/serviceClass/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve the list of subscriber devices

GEThttps://localhost:16005/api/v1/subscriberDevice

Query parameters

Response

200400403404

list of subscriber devices

Body

application/json

one of

SubscriberDeviceList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "subscriberDevices": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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",
          "weight": 0,
          "configuration": "text"
        }
      ],
      "serviceClass": "123e4567-e89b-12d3-a456-426614174000",
      "billingCode": "text"
    }
  ]
}

Retrieve a subscriber device

GEThttps://localhost:16005/api/v1/subscriberDevice/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/subscriberDevice/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a subscriber device

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

Path parameters

uuid*string (uuid)

Example: "should be set to 0 when creating a new operator"

Body

application/json

allOfObjectInfo (object)

serialNumberstring

realMacAddressstring

operatorIdstring (uuid)

deviceTypestring

subscriberIdstring (uuid)

qrCodestring

geoCodestring

locationSubLocation (object)

contactSubContact (object)

deviceRulesDeviceRules (object)

statestring

localestring

managementPolicystring (uuid)

suspendedboolean

configurationarray of DeviceConfigurationElement (object)

serviceClassstring (uuid)

billingCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Update a subscriber device

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

Path parameters

uuid*string (uuid)

Body

application/json

allOfObjectInfo (object)

serialNumberstring

realMacAddressstring

operatorIdstring (uuid)

deviceTypestring

subscriberIdstring (uuid)

qrCodestring

geoCodestring

locationSubLocation (object)

contactSubContact (object)

deviceRulesDeviceRules (object)

statestring

localestring

managementPolicystring (uuid)

suspendedboolean

configurationarray of DeviceConfigurationElement (object)

serviceClassstring (uuid)

billingCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a subscriber device

DELETEhttps://localhost:16005/api/v1/subscriberDevice/{uuid}

Path parameters

uuid*string (uuid)

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/subscriberDevice/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve a list of locations.

GEThttps://localhost:16005/api/v1/operatorLocation

Query parameters

Response

200400403404

Return a list of Locations

Body

application/json

one of

OperatorLocationList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "locations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific location.

GEThttps://localhost:16005/api/v1/operatorLocation/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operatorLocation/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a specific location.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new location

allOfObjectInfo (object)

typeenum

SERVICEEQUIPMENTAUTOMANUALSPECIALUNKNOWNCORPORATE

buildingNamestring

addressLinesarray of string

citystring

statestring

postalstring

countrystring

phonesarray of string

mobilesarray of string

operatorIdstring (uuid)

subscriberDeviceIdstring (uuid)

geoCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific location.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify the new location

allOfObjectInfo (object)

typeenum

SERVICEEQUIPMENTAUTOMANUALSPECIALUNKNOWNCORPORATE

buildingNamestring

addressLinesarray of string

citystring

statestring

postalstring

countrystring

phonesarray of string

mobilesarray of string

operatorIdstring (uuid)

subscriberDeviceIdstring (uuid)

geoCodestring

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific location.

DELETEhttps://localhost:16005/api/v1/operatorLocation/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operatorLocation/{uuid}?force=false', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve a list of operator contacts.

GEThttps://localhost:16005/api/v1/operatorContact

Query parameters

Response

200400403404

Return a list of operator contacts

Body

application/json

one of

OperatorContactList (object)CountAnswer (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "contacts": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 0,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 0,
        "modified": 0,
        "tags": [
          0
        ]
      },
      "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"
    }
  ]
}

Retrieve a specific operator contact.

GEThttps://localhost:16005/api/v1/operatorContact/{uuid}

Path parameters

uuid*string (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operatorContact/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a specific operator contact.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to create the new entity

allOfObjectInfo (object)

typeenum

SUBSCRIBERUSERINSTALLERCSRMANAGERBUSINESSOWNERTECHNICIANCORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesarray of string

mobilesarray of string

primaryEmailstring

secondaryEmailstring

accessPINstring

operatorIdstring (uuid)

subscriberDeviceIdstring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Modify a specific operator contact.

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

Path parameters

uuid*string (uuid)

Body

application/json

Information used to modify the new entity

allOfObjectInfo (object)

typeenum

SUBSCRIBERUSERINSTALLERCSRMANAGERBUSINESSOWNERTECHNICIANCORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesarray of string

mobilesarray of string

primaryEmailstring

secondaryEmailstring

accessPINstring

operatorIdstring (uuid)

subscriberDeviceIdstring (uuid)

Response

200400403404

Request

JavaScriptCurlPythonHTTP

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();

Delete a specific operator contact.

DELETEhttps://localhost:16005/api/v1/operatorContact/{uuid}

Path parameters

uuid*string (uuid)

Query parameters

Response

204400403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/operatorContact/{uuid}?force=false', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get the last version of the dashboard.

GEThttps://localhost:16005/api/v1/dashboard

Response

200403404

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/dashboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve different values from the running service.

GEThttps://localhost:16005/api/v1/system

Query parameters

Response

200403404

Successful command execution

Body

application/json

one of

SystemInfoResults (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://localhost:16005/api/v1/system?command=info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "text",
  "uptime": 0,
  "start": 0,
  "os": "text",
  "processors": 0,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 0
    }
  ]
}

Perform some system wide commands.

POSThttps://localhost:16005/api/v1/system

Body

application/json

Command details

one of

SystemCommandSetLogLevel (object)SystemCommandReload (object)SystemCommandGetLogLevels (object)SystemCommandGetLogLevelNames (object)SystemCommandGetSubsystemNames (object)

Response

200403404

Successful command execution

Body

application/json

one of

SystemGetLogLevelsResult (object)SystemCommandGetLogLevelNamesResult (object)SystemGetSubSystemNamesResult (object)

Request

JavaScriptCurlPythonHTTP

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();

Response

200

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}