Skip to content

Venue Service API & Model Documentation (0.2.8)

Overview

Rate Limit

For the Venue REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Languages
Servers
Generated server url

http://localhost/

Venue

Manage venue.

Operations

Access VenuesDeprecated

Request

Get venue list.

No request payload

Responses

OK

BodyArray [
idstring

Venue identifier

namestring[ 2 .. 32 ] characters\s*\S+\s*\S+.*required

Venue name

descriptionstring

Venue description

addressobject(AddressView)required
address.​countrystringrequired

Country

address.​countryCodestring

Country code

address.​citystringrequired

City

address.​addressLinestring

Address line

address.​latitudenumber(double)

Latitude

address.​longitudenumber(double)

Longitude

address.​timezonestring

Timezone

address.​notesstring

Notes

tagsArray of strings
floorPlansArray of objects(FloorPlanView)
isTemplateboolean
]
Response
[ { "id": "string", "name": "string", "description": "string", "address": { … }, "tags": [ … ], "floorPlans": [ … ], "isTemplate": true } ]

Revoke Venues by IDsDeprecated

Request

Delete venues by list. WARNING: Note that all network devices under these venues will be removed as well.

BodyrequiredArray [
string
]
[ "string" ]

Responses

Accepted

Body
requestIdstring
responseobject
Response
{ "requestId": "string", "response": {} }