Provisioning Service

Retrieve a list of entities.

get

/entity

Authorizations

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/entity' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of elements

Retrieve a specific entity.

get

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a specific entity.

post

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

allOfobject

parentstring · uuid

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

childrenstring · uuid[]

venuesstring · uuid[]

The list of UUID of the venues for this entity

contactsstring · uuid[]

The list of UUID of the contacts for the entity

locationsstring · uuid[]

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuid

deviceConfigurationstring · uuid

devicesstring · uuid[]

managementPoliciesstring · uuid[]

The list of UUID of the venues for this entity

variablesstring · uuid[]

The list of UUID of the venues for this entity

managementRolesstring · uuid[]

The list of UUID of the venues for this entity

mapsstring · uuid[]

The list of UUID of the venues for this entity

configurationsstring · uuid[]

The list of UUID of the venues for this entity

deviceRulesobject

sourceIPobject

defaultEntityboolean · default: false

typestring · enum · default: normal

Options: normal, subscriber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific entity.

put

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

parentstring · uuid

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

childrenstring · uuid[]

venuesstring · uuid[]

The list of UUID of the venues for this entity

contactsstring · uuid[]

The list of UUID of the contacts for the entity

locationsstring · uuid[]

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuid

deviceConfigurationstring · uuid

devicesstring · uuid[]

managementPoliciesstring · uuid[]

The list of UUID of the venues for this entity

variablesstring · uuid[]

The list of UUID of the venues for this entity

managementRolesstring · uuid[]

The list of UUID of the venues for this entity

mapsstring · uuid[]

The list of UUID of the venues for this entity

configurationsstring · uuid[]

The list of UUID of the venues for this entity

deviceRulesobject

sourceIPobject

defaultEntityboolean · default: false

typestring · enum · default: normal

Options: normal, subscriber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific entity.

delete

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of contacts.

get

/contact

Authorizations

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 contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of contacts

uuidOnlyboolean

return only the UUIDs of contacts

venuestring · uuid

entitystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/contact' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of contacts

Retrieve a specific contact.

get

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Success

Create a specific entity.

post

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesstring[]

mobilesstring[]

primaryEmailstring

secondaryEmailstring

accessPINstring

inUsestring · uuid[]

entitystring · uuid

managementPolicystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific contact.

put

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesstring[]

mobilesstring[]

primaryEmailstring

secondaryEmailstring

accessPINstring

inUsestring · uuid[]

entitystring · uuid

managementPolicystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific contact.

delete

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/contact/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of locations.

get

/location

Authorizations

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 Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of Locations

uuidOnlyboolean

return only the UUIDs of Locations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/location' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of Locations

Retrieve a specific location.

get

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Success

Create a specific location.

post

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

buildingNamestring

addressLinesstring[]

citystring

statestring

postalstring

countrystring

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

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

entitystring · uuid

managementPolicystring · uuid

geoCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific location.

put

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

buildingNamestring

addressLinesstring[]

citystring

statestring

postalstring

countrystring

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

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

entitystring · uuid

managementPolicystring · uuid

geoCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific location.

delete

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/location/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of inventory.

get

/inventory

Authorizations

Query parameters

entitystring · uuid

venuestring · uuid

unassignedboolean

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

serialOnlyboolean

only serial numbers of full device details

countOnlyboolean

return the number of devices

withExtendedInfoboolean

return extended information

orderBystring

return extended information

Example: serialNumber:a,created:d

orderSpecboolean · default: false

return extended information

rrmOnlyboolean · default: false

return the list of devices under RRM

subscriberstring · uuid

return the list of devices under RRM

rrmSettingsboolean · default: false

return RRM settings for a specific device

resolveConfigboolean · default: false

return the resolved configuration for a specific device

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/inventory' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "serialNumbers": [
    "text"
  ]
}

Return a list of elements

Retrieve a specific inventory tag.

get

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Query parameters

configboolean

explainboolean

firmwareOptionsboolean

applyConfigurationboolean

subscriberEntitystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Succesful retrieve configuratiopn or part of the configuration

Create a specific Inventory.

post

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Body

allOfobject

serialNumberstring

deviceTypestring

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

qrCodestring

geoCodestring

locationstring · uuid

contactstring · uuid

deviceConfigurationstring · uuid

deviceRulesobject

managementPolicystring · uuid

statestring

devClassstring · enum

Options: any, venue, entity, subscriber

localestring · min: 2 · max: 2

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific inventory.

put

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Query parameters

unassignboolean

removeSubscriberstring · uuidrequired

Body

allOfobject

serialNumberstring

deviceTypestring

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

qrCodestring

geoCodestring

locationstring · uuid

contactstring · uuid

deviceConfigurationstring · uuid

deviceRulesobject

managementPolicystring · uuid

statestring

devClassstring · enum

Options: any, venue, entity, subscriber

localestring · min: 2 · max: 2

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}?removeSubscriber=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

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

success

Delete a specific inventory.

delete

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of venues.

get

/venue

Authorizations

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 · default: false

return the devices under a venue

getChildrenboolean · default: false

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/venue' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of venues.

Retrieve a specific venue.

get

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Create a specific venue.

post

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

createObjectsobject

Body

allOfobject

entitystring · uuid

parentstring · uuid

childrenstring · uuid[]

managementPolicystring · uuid

devicesstring · uuid[]

topologyobject[]

designstring

deviceConfigurationstring · uuid

contactsstring · uuid[]

locationstring · uuid

deviceRulesobject

sourceIPobject

managementPoliciesstring · uuid[]

The list of UUID of the venues for this entity

managementRolesstring · uuid[]

The list of UUID of the venues for this entity

variablesstring · uuid[]

The list of UUID of the venues for this entity

mapsstring · uuid[]

The list of UUID of the venues for this entity

configurationsstring · uuid[]

The list of UUID of the venues for this entity

boardsstring · uuid[]

The list of OWAnalytics Boards created for this venue

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
    ]
  }'

200

403

404

No body

Modify a specific venue.

put

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

updateAllDevicesboolean · default: false

rebootAllDevicesboolean · default: false

testUpdateOnlyboolean · default: false

upgradeAllDevicesboolean · default: false

Body

allOfobject

entitystring · uuid

parentstring · uuid

childrenstring · uuid[]

managementPolicystring · uuid

devicesstring · uuid[]

topologyobject[]

designstring

deviceConfigurationstring · uuid

contactsstring · uuid[]

locationstring · uuid

deviceRulesobject

sourceIPobject

managementPoliciesstring · uuid[]

The list of UUID of the venues for this entity

managementRolesstring · uuid[]

The list of UUID of the venues for this entity

variablesstring · uuid[]

The list of UUID of the venues for this entity

mapsstring · uuid[]

The list of UUID of the venues for this entity

configurationsstring · uuid[]

The list of UUID of the venues for this entity

boardsstring · uuid[]

The list of OWAnalytics Boards created for this venue

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
    ]
  }'

200

400

403

404

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

Return venue information or list of serial number updated

Delete a specific venue.

delete

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve the list of maps

get

/map

Authorizations

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

myMapsboolean

Return only maps I created

sharedWithMeboolean

Return only maps shared with Me

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/map' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of Venues

Retrieve a specific map.

get

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Successfull retrieval of a map

Create a specific map.

post

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

managementPolicystring · uuid

datastring

visibilitystring · enum

Options: private, public, select

creatorstring · uuid

accessobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
        }
      ]
    }
  }'

200

403

404

No body

Modify a specific map.

put

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

managementPolicystring · uuid

datastring

visibilitystring · enum

Options: private, public, select

creatorstring · uuid

accessobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
        }
      ]
    }
  }'

200

400

403

404

No body

Delete a specific map.

delete

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Get a list of policies.

get

/managementPolicy

Authorizations

Query parameters

entitystring · uuid

venuestring · uuid

unassignedboolean

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 policies comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of policies

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/managementPolicy' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of Venues

Retrieve a specific policy.

get

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Succesful retrieve a management policy

Create a specific policy.

post

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entriesobject[]

inUsestring · uuid[]

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

entitystring · uuid

venuestring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific policy.

put

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entriesobject[]

inUsestring · uuid[]

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

entitystring · uuid

venuestring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific policy.

delete

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of management roles.

get

/managementRole

Authorizations

Query parameters

entitystring · uuid

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 roles

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/managementRole' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of elements

Retrieve a specific management role.

get

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Success

Create a specific management role.

post

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

managementPolicystring · uuid

usersstring · uuid[]

inUsestring · uuid[]

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

entitystring · uuid

venuestring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific management role.

put

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

managementPolicystring · uuid

usersstring · uuid[]

inUsestring · uuid[]

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

entitystring · uuid

venuestring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific management role.

delete

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of configurations.

get

/configuration

Authorizations

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

venuestring · uuid

entitystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/configuration' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of elements

Retrieve a specific configuration.

get

/configuration/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/configuration/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Success

Create a specific configuration.

post

/configuration/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

validateOnlyboolean

Body

allOfobject

managementPolicystring · uuid

deviceTypesstring[]

configurationobject[]

variablesstring · uuid[]

inUsestring · uuid[]

subscriberOnlyboolean · default: false

deviceRulesobject

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/configuration/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "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"
  }'

200

400

403

404

No body

Modify a specific configuration.

put

/configuration/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

managementPolicystring · uuid

deviceTypesstring[]

configurationobject[]

variablesstring · uuid[]

inUsestring · uuid[]

subscriberOnlyboolean · default: false

deviceRulesobject

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/configuration/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "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"
  }'

200

400

403

404

No body

Delete a specific configuration.

delete

/configuration/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/configuration/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Get the country code for an IP address

get

/iptocountry

Authorizations

Query parameters

ipliststringrequired

Example: 10.2.2.2,10.3.4.3

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

List of country codes.

get

/signup

Authorizations

Query parameters

emailstring · email

macAddressstring

signupUUIDstring · uuid

dashboardboolean · default: false

deviceIDstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/signup' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Successfull completion

post

/signup

Authorizations

Query parameters

emailstring · emailrequired

macAddressstringrequired

deviceIDstring

registrationIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/signup?email=hello%40example.com&macAddress=text&registrationId=text' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

put

/signup

Authorizations

Query parameters

signupUUIDstring · uuidrequired

operationstring · enumrequired

Options: cancel, emailVerified, deviceVerified

Body

reasonstring

timeinteger · int64

errorCodeinteger · int32

statusstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/signup?signupUUID=123e4567-e89b-12d3-a456-426614174000&operation=cancel' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reason": "text",
    "time": 1,
    "errorCode": 1,
    "status": "text"
  }'

200

400

403

404

No body

delete

/signup

Authorizations

Query parameters

emailstring · email

macAddressstring

signupUUIDstring · uuid

deviceIDstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/signup' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve lists of control blocks

get

/variable

Authorizations

Query parameters

venuestring · uuid

entitystring · uuid

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/variable' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Retrieve the list of currently configured operators

get

/operator

Authorizations

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 operators comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of operators

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operator' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Successfully retrieved operator list

Retrieve an operator

get

/operator/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operator/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a new operator

post

/operator/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

variablesobject[]

defaultOperatorboolean · default: false

deviceRulesobject

managementPolicystring · uuid

managementRolesobject

sourceIPobject

registrationIdstring · min: 4 · max: 16

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/operator/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "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": 1,
                "createdBy": "text",
                "note": "text"
              }
            ],
            "created": 1,
            "modified": 1,
            "tags": [
              1
            ]
          },
          "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"
  }'

200

400

403

404

No body

Update an existing operator

put

/operator/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

variablesobject[]

defaultOperatorboolean · default: false

deviceRulesobject

managementPolicystring · uuid

managementRolesobject

sourceIPobject

registrationIdstring · min: 4 · max: 16

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/operator/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "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": 1,
                "createdBy": "text",
                "note": "text"
              }
            ],
            "created": 1,
            "modified": 1,
            "tags": [
              1
            ]
          },
          "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"
  }'

200

400

403

404

No body

Delete an operator

delete

/operator/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/operator/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve the list of currently configured service class

get

/serviceClass

Authorizations

Query parameters

operatorIdstring · uuidrequired

The operator

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 operators comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of operators

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/serviceClass?operatorId=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Successfully retrieved operator list

Retrieve a service class

get

/serviceClass/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/serviceClass/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a service class

post

/serviceClass/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

operatorIdstring · uuid

costnumber

currencystring · min: 3 · max: 3

managementPolicystring · uuid

periodstring · enum · default: monthly

Options: hourly, daily, monthly, yearly, quarterly, lifetime, custom1, custom2, custom3, custom4

billingCodestring

variablesobject[]

defaultServiceboolean · default: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/serviceClass/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "operatorId": "123e4567-e89b-12d3-a456-426614174000",
    "cost": 1,
    "currency": "text",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "period": "monthly",
    "billingCode": "text",
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "prefix": "text",
        "value": "text"
      }
    ],
    "defaultService": false
  }'

200

400

403

404

No body

Update a service class

put

/serviceClass/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

operatorIdstring · uuid

costnumber

currencystring · min: 3 · max: 3

managementPolicystring · uuid

periodstring · enum · default: monthly

Options: hourly, daily, monthly, yearly, quarterly, lifetime, custom1, custom2, custom3, custom4

billingCodestring

variablesobject[]

defaultServiceboolean · default: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/serviceClass/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "operatorId": "123e4567-e89b-12d3-a456-426614174000",
    "cost": 1,
    "currency": "text",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "period": "monthly",
    "billingCode": "text",
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "prefix": "text",
        "value": "text"
      }
    ],
    "defaultService": false
  }'

200

400

403

404

No body

Delete a service class

delete

/serviceClass/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/serviceClass/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve the list of subscriber devices

get

/subscriberDevice

Authorizations

Query parameters

operatorIdstring · uuidrequired

The operator

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 operators comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of operators

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/subscriberDevice?operatorId=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

list of subscriber devices

Retrieve a subscriber device

get

/subscriberDevice/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/subscriberDevice/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a subscriber device

post

/subscriberDevice/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

serialNumberstring

realMacAddressstring

operatorIdstring · uuid

deviceTypestring

subscriberIdstring · uuid

qrCodestring

geoCodestring

locationobject

contactobject

deviceRulesobject

statestring

localestring · min: 2 · max: 2

managementPolicystring · uuid

suspendedboolean · default: false

configurationobject[]

serviceClassstring · uuid

billingCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/subscriberDevice/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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": 1,
        "configuration": "text"
      }
    ],
    "serviceClass": "123e4567-e89b-12d3-a456-426614174000",
    "billingCode": "text"
  }'

200

400

403

404

No body

Update a subscriber device

put

/subscriberDevice/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

serialNumberstring

realMacAddressstring

operatorIdstring · uuid

deviceTypestring

subscriberIdstring · uuid

qrCodestring

geoCodestring

locationobject

contactobject

deviceRulesobject

statestring

localestring · min: 2 · max: 2

managementPolicystring · uuid

suspendedboolean · default: false

configurationobject[]

serviceClassstring · uuid

billingCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/subscriberDevice/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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": 1,
        "configuration": "text"
      }
    ],
    "serviceClass": "123e4567-e89b-12d3-a456-426614174000",
    "billingCode": "text"
  }'

200

400

403

404

No body

Delete a subscriber device

delete

/subscriberDevice/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/subscriberDevice/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of locations.

get

/operatorLocation

Authorizations

Query parameters

operatorIdstring · uuidrequired

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 Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of Locations

uuidOnlyboolean

return only the UUIDs of Locations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operatorLocation?operatorId=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of Locations

Retrieve a specific location.

get

/operatorLocation/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operatorLocation/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a specific location.

post

/operatorLocation/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

buildingNamestring

addressLinesstring[]

citystring

statestring

postalstring

countrystring

phonesstring[]

mobilesstring[]

operatorIdstring · uuid

subscriberDeviceIdstring · uuid

geoCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/operatorLocation/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific location.

put

/operatorLocation/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

buildingNamestring

addressLinesstring[]

citystring

statestring

postalstring

countrystring

phonesstring[]

mobilesstring[]

operatorIdstring · uuid

subscriberDeviceIdstring · uuid

geoCodestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/operatorLocation/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific location.

delete

/operatorLocation/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/operatorLocation/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Retrieve a list of operator contacts.

get

/operatorContact

Authorizations

Query parameters

operatorIdstring · uuidrequired

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 operator contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of operator contacts

uuidOnlyboolean

return only the UUIDs of operator contacts

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operatorContact?operatorId=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

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

Return a list of operator contacts

Retrieve a specific operator contact.

get

/operatorContact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/operatorContact/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

Create a specific operator contact.

post

/operatorContact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesstring[]

mobilesstring[]

primaryEmailstring

secondaryEmailstring

accessPINstring

operatorIdstring · uuid

subscriberDeviceIdstring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/operatorContact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Modify a specific operator contact.

put

/operatorContact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

phonesstring[]

mobilesstring[]

primaryEmailstring

secondaryEmailstring

accessPINstring

operatorIdstring · uuid

subscriberDeviceIdstring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/operatorContact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "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"
  }'

200

400

403

404

No body

Delete a specific operator contact.

delete

/operatorContact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/operatorContact/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

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

The requested operation was performed.

Get the last version of the dashboard.

get

/dashboard

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/dashboard' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve different values from the running service.

get

/system

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16005/api/v1/system?command=info' \
  --header 'Authorization: Bearer JWT'

200

403

404

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

Successful command execution

Perform some system wide commands.

post

/system

Authorizations

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/system' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "setloglevel",
    "subsystems": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

403

404

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

Successful command execution

Retrieve a list of entities.

Retrieve a specific entity.

Create a specific entity.

Show child attributes

Show child attributes

Show child attributes

Modify a specific entity.

Show child attributes

Show child attributes

Show child attributes

Delete a specific entity.

Retrieve a list of contacts.

Retrieve a specific contact.

Create a specific entity.

Show child attributes

Modify a specific contact.

Show child attributes

Delete a specific contact.

Retrieve a list of locations.

Retrieve a specific location.

Create a specific location.

Show child attributes

Modify a specific location.

Show child attributes

Delete a specific location.

Retrieve a list of inventory.

Retrieve a specific inventory tag.

Create a specific Inventory.

Show child attributes

Show child attributes

Modify a specific inventory.

Show child attributes

Show child attributes

Delete a specific inventory.

Retrieve a list of venues.

Retrieve a specific venue.

Create a specific venue.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Modify a specific venue.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Delete a specific venue.

Retrieve the list of maps

Retrieve a specific map.

Create a specific map.

Show child attributes

Show child attributes

Modify a specific map.

Show child attributes

Show child attributes

Delete a specific map.

Get a list of policies.

Retrieve a specific policy.

Create a specific policy.

Show child attributes

Show child attributes

Modify a specific policy.

Show child attributes

Show child attributes

Delete a specific policy.

Retrieve a list of management roles.

Retrieve a specific management role.

Create a specific management role.

Show child attributes

Modify a specific management role.

Show child attributes

Delete a specific management role.

Retrieve a list of configurations.

Retrieve a specific configuration.

Create a specific configuration.

Show child attributes

Show child attributes

Show child attributes

Modify a specific configuration.