Provisioning Service

PreviousFirmware Management Service NextAnalytics Service

Was this helpful?

Retrieve a list of entities.

get

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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": true,
      "type": "normal"
    }
  ]
}

Return a list of elements

Retrieve a specific entity.

get

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

Delete a specific entity.

delete

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

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of contacts

uuidOnlybooleanoptional

return only the UUIDs of contacts

venuestring · uuidoptional

entitystring · uuidoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

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

Delete a specific contact.

delete

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

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of Locations

uuidOnlybooleanoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

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

Delete a specific location.

delete

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

Authorizations

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

serialOnlybooleanoptional

only serial numbers of full device details

countOnlybooleanoptional

return the number of devices

withExtendedInfobooleanoptional

return extended information

orderBystringoptional

return extended information

Example: serialNumber:a,created:d

orderSpecboolean · default: falseoptional

return extended information

rrmOnlyboolean · default: falseoptional

return the list of devices under RRM

subscriberstring · uuidoptional

return the list of devices under RRM

rrmSettingsboolean · default: falseoptional

return RRM settings for a specific device

resolveConfigboolean · default: falseoptional

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

Authorizations

Path parameters

serialNumberstring · uuidrequired

Query parameters

configbooleanoptional

explainbooleanoptional

firmwareOptionsbooleanoptional

applyConfigurationbooleanoptional

subscriberEntitystring · uuidoptional

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

Delete a specific inventory.

delete

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

Authorizations

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

deviceTypestringoptional

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of Venues comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of devices

getDevicesboolean · default: falseoptional

return the devices under a venue

getChildrenboolean · default: falseoptional

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

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

Delete a specific venue.

delete

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

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

myMapsbooleanoptional

Return only maps I created

sharedWithMebooleanoptional

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

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

Delete a specific map.

delete

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

Authorizations

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of policies comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

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

Delete a specific policy.

delete

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

Authorizations

Query parameters

entitystring · uuidoptional

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

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

Delete a specific management role.

delete

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

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of devices

venuestring · uuidoptional

entitystring · uuidoptional

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": true,
      "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

Authorizations

Path parameters

uuidstring · uuidrequired

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

Query parameters

expandInUsebooleanoptional

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": true,
  "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

Delete a specific configuration.

delete

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

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

Authorizations

Query parameters

emailstring · emailoptional

macAddressstringoptional

signupUUIDstring · uuidoptional

dashboardboolean · default: falseoptional

deviceIDstringoptional

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": "name@gmail.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

Authorizations

Query parameters

emailstring · emailrequired

macAddressstringrequired

deviceIDstringoptional

registrationIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

No body

delete

Authorizations

Query parameters

emailstring · emailoptional

macAddressstringoptional

signupUUIDstring · uuidoptional

deviceIDstringoptional

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

Authorizations

Query parameters

venuestring · uuidoptional

entitystring · uuidoptional

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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

Authorizations

Query parameters

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of operators comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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": true,
      "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

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

Delete an operator

delete

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

Authorizations

Query parameters

operatorIdstring · uuidrequired

The operator

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of operators comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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": "hourly",
      "billingCode": "text",
      "variables": [
        {
          "type": "integer",
          "weight": 1,
          "prefix": "text",
          "value": "text"
        }
      ],
      "defaultService": true
    }
  ]
}

Successfully retrieved operator list

Retrieve a service class

get

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

Delete a service class

delete

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

Authorizations

Query parameters

operatorIdstring · uuidrequired

The operator

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of operators comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

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": true,
      "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

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

Delete a subscriber device

delete

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

Authorizations

Query parameters

operatorIdstring · uuidrequired

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of Locations

uuidOnlybooleanoptional

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

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

Delete a specific location.

delete

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

Authorizations

Query parameters

operatorIdstring · uuidrequired

offsetintegeroptional

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

limitintegeroptional

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

filterstringoptional

Filter the results

selectstringoptional

Supply a list of operator contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of operator contacts

uuidOnlybooleanoptional

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

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

Delete a specific operator contact.

delete

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

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

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

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

Create a specific entity.

post

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

allOfobjectoptional

parentstring · uuidoptional

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

childrenstring · uuid[]optional

venuesstring · uuid[]optional

The list of UUID of the venues for this entity

contactsstring · uuid[]optional

The list of UUID of the contacts for the entity

locationsstring · uuid[]optional

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuidoptional

deviceConfigurationstring · uuidoptional

devicesstring · uuid[]optional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

deviceRulesobjectoptional

sourceIPobjectoptional

defaultEntityboolean · default: falseoptional

typestring · enum · default: "normal"optional

Available options:

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": true,
    "type": "normal"
  }'

200

400

403

404

No body

Modify a specific entity.

put

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

parentstring · uuidoptional

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

childrenstring · uuid[]optional

venuesstring · uuid[]optional

The list of UUID of the venues for this entity

contactsstring · uuid[]optional

The list of UUID of the contacts for the entity

locationsstring · uuid[]optional

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuidoptional

deviceConfigurationstring · uuidoptional

devicesstring · uuid[]optional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

deviceRulesobjectoptional

sourceIPobjectoptional

defaultEntityboolean · default: falseoptional

typestring · enum · default: "normal"optional

Available options:

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": true,
    "type": "normal"
  }'

200

400

403

404

No body

Create a specific entity.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

inUsestring · uuid[]optional

entitystring · uuidoptional

managementPolicystring · uuidoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

inUsestring · uuid[]optional

entitystring · uuidoptional

managementPolicystring · uuidoptional

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

Create a specific location.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

managementPolicystring · uuidoptional

geoCodestringoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

managementPolicystring · uuidoptional

geoCodestringoptional

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

Create a specific Inventory.

post

Authorizations

Path parameters

serialNumberstring · uuidrequired

Body

allOfobjectoptional

serialNumberstringoptional

deviceTypestringoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationstring · uuidoptional

contactstring · uuidoptional

deviceConfigurationstring · uuidoptional

deviceRulesobjectoptional

managementPolicystring · uuidoptional

statestringoptional

devClassstring · enumoptional

Available options:

localestring · min: 2 · max: 2optional

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

Authorizations

Path parameters

serialNumberstring · uuidrequired

Query parameters

unassignbooleanoptional

removeSubscriberstring · uuidrequired

Body

allOfobjectoptional

serialNumberstringoptional

deviceTypestringoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationstring · uuidoptional

contactstring · uuidoptional

deviceConfigurationstring · uuidoptional

deviceRulesobjectoptional

managementPolicystring · uuidoptional

statestringoptional

devClassstring · enumoptional

Available options:

localestring · min: 2 · max: 2optional

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

Create a specific venue.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

createObjectsobjectoptional

Body

allOfobjectoptional

entitystring · uuidoptional

parentstring · uuidoptional

childrenstring · uuid[]optional

managementPolicystring · uuidoptional

devicesstring · uuid[]optional

topologyobject[]optional

designstringoptional

deviceConfigurationstring · uuidoptional

contactsstring · uuid[]optional

locationstring · uuidoptional

deviceRulesobjectoptional

sourceIPobjectoptional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

boardsstring · uuid[]optional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

updateAllDevicesboolean · default: falseoptional

rebootAllDevicesboolean · default: falseoptional

testUpdateOnlyboolean · default: falseoptional

upgradeAllDevicesboolean · default: falseoptional

Body

allOfobjectoptional

entitystring · uuidoptional

parentstring · uuidoptional

childrenstring · uuid[]optional

managementPolicystring · uuidoptional

devicesstring · uuid[]optional

topologyobject[]optional

designstringoptional

deviceConfigurationstring · uuidoptional

contactsstring · uuid[]optional

locationstring · uuidoptional

deviceRulesobjectoptional

sourceIPobjectoptional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

boardsstring · uuid[]optional

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

Create a specific map.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entitystring · uuidoptional

venuestring · uuidoptional

managementPolicystring · uuidoptional

datastringoptional

visibilitystring · enumoptional

Available options:

creatorstring · uuidoptional

accessobjectoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entitystring · uuidoptional

venuestring · uuidoptional

managementPolicystring · uuidoptional

datastringoptional

visibilitystring · enumoptional

Available options:

creatorstring · uuidoptional

accessobjectoptional

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

Create a specific policy.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entriesobject[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

venuestring · uuidoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entriesobject[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

venuestring · uuidoptional

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

Create a specific management role.

post

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

managementPolicystring · uuidoptional

usersstring · uuid[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

venuestring · uuidoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

managementPolicystring · uuidoptional

usersstring · uuid[]optional

inUsestring · uuid[]optional

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

entitystring · uuidoptional

venuestring · uuidoptional

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

Create a specific configuration.

post

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

validateOnlybooleanoptional

Body

allOfobjectoptional

managementPolicystring · uuidoptional

deviceTypesstring[]optional

configurationobject[]optional

variablesstring · uuid[]optional

inUsestring · uuid[]optional

subscriberOnlyboolean · default: falseoptional

deviceRulesobjectoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

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": true,
    "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

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

managementPolicystring · uuidoptional

deviceTypesstring[]optional

configurationobject[]optional

variablesstring · uuid[]optional

inUsestring · uuid[]optional

subscriberOnlyboolean · default: falseoptional

deviceRulesobjectoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

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": true,
    "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

put

Authorizations

Query parameters

signupUUIDstring · uuidrequired

operationstring · enumrequired

Available options:

Body

reasonstringoptional

timeinteger · int64optional

errorCodeinteger · int32optional

statusstringoptional

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

Create a new operator

post

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

variablesobject[]optional

defaultOperatorboolean · default: falseoptional

deviceRulesobjectoptional

managementPolicystring · uuidoptional

managementRolesobjectoptional

sourceIPobjectoptional

registrationIdstring · min: 4 · max: 16optional

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": true,
    "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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

variablesobject[]optional

defaultOperatorboolean · default: falseoptional

deviceRulesobjectoptional

managementPolicystring · uuidoptional

managementRolesobjectoptional

sourceIPobjectoptional

registrationIdstring · min: 4 · max: 16optional

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": true,
    "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

Create a service class

post

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

operatorIdstring · uuidoptional

costnumberoptional

currencystring · min: 3 · max: 3optional

managementPolicystring · uuidoptional

periodstring · enum · default: "monthly"optional

Available options:

billingCodestringoptional

variablesobject[]optional

defaultServiceboolean · default: falseoptional

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": "hourly",
    "billingCode": "text",
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "prefix": "text",
        "value": "text"
      }
    ],
    "defaultService": true
  }'

200

400

403

404

No body

Update a service class

put

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

operatorIdstring · uuidoptional

costnumberoptional

currencystring · min: 3 · max: 3optional

managementPolicystring · uuidoptional

periodstring · enum · default: "monthly"optional

Available options:

billingCodestringoptional

variablesobject[]optional

defaultServiceboolean · default: falseoptional

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": "hourly",
    "billingCode": "text",
    "variables": [
      {
        "type": "integer",
        "weight": 1,
        "prefix": "text",
        "value": "text"
      }
    ],
    "defaultService": true
  }'

200

400

403

404

No body

Create a subscriber device

post

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobjectoptional

serialNumberstringoptional

realMacAddressstringoptional

operatorIdstring · uuidoptional

deviceTypestringoptional

subscriberIdstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationobjectoptional

contactobjectoptional

deviceRulesobjectoptional

statestringoptional

localestring · min: 2 · max: 2optional

managementPolicystring · uuidoptional

suspendedboolean · default: falseoptional

configurationobject[]optional

serviceClassstring · uuidoptional

billingCodestringoptional

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": true,
    "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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

serialNumberstringoptional

realMacAddressstringoptional

operatorIdstring · uuidoptional

deviceTypestringoptional

subscriberIdstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationobjectoptional

contactobjectoptional

deviceRulesobjectoptional

statestringoptional

localestring · min: 2 · max: 2optional

managementPolicystring · uuidoptional

suspendedboolean · default: falseoptional

configurationobject[]optional

serviceClassstring · uuidoptional

billingCodestringoptional

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": true,
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "configuration": "text"
      }
    ],
    "serviceClass": "123e4567-e89b-12d3-a456-426614174000",
    "billingCode": "text"
  }'

200

400

403

404

No body

Create a specific location.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

operatorIdstring · uuidoptional

subscriberDeviceIdstring · uuidoptional

geoCodestringoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

operatorIdstring · uuidoptional

subscriberDeviceIdstring · uuidoptional

geoCodestringoptional

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

Create a specific operator contact.

post

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

operatorIdstring · uuidoptional

subscriberDeviceIdstring · uuidoptional

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

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptional

Available options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

operatorIdstring · uuidoptional

subscriberDeviceIdstring · uuidoptional

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

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

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.

Delete a specific entity.

Retrieve a list of contacts.

Retrieve a specific contact.

Delete a specific contact.

Retrieve a list of locations.

Retrieve a specific location.

Delete a specific location.

Retrieve a list of inventory.

Retrieve a specific inventory tag.

Delete a specific inventory.

Retrieve a list of venues.

Retrieve a specific venue.

Delete a specific venue.

Retrieve the list of maps

Retrieve a specific map.

Delete a specific map.

Get a list of policies.

Retrieve a specific policy.

Delete a specific policy.

Retrieve a list of management roles.

Retrieve a specific management role.

Delete a specific management role.

Retrieve a list of configurations.

Retrieve a specific configuration.

Delete a specific configuration.

Get the country code for an IP address

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

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

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

Retrieve lists of control blocks

Retrieve the list of currently configured operators

Retrieve an operator

Delete an operator

Retrieve the list of currently configured service class

Retrieve a service class

Delete a service class

Retrieve the list of subscriber devices

Retrieve a subscriber device

Delete a subscriber device

Retrieve a list of locations.

Retrieve a specific location.

Delete a specific location.

Retrieve a list of operator contacts.

Retrieve a specific operator contact.

Delete a specific operator contact.

Get the last version of the dashboard.

Retrieve different values from the running service.

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

Create a specific entity.

Show child attributes

Modify a specific contact.

Show child attributes

Create a specific location.

Show child attributes

Modify a specific location.

Show child attributes

Create a specific Inventory.

Show child attributes

Show child attributes

Modify a specific inventory.

Show child attributes

Show child attributes

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