Skip to content

Venue Service API & Model Documentation (0.2.8)

Ruckus Network Technical Documents

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
Download PDF
Languages
Servers
Generated server url
http://localhost/

Venue Template

Manage venue template.

Operations

Get Venue Template by ID

Request

Get venue template.

Path
venueTemplateIdstringrequired
No request payload

Responses

OK

Body
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
isTemplateboolean
templateVersioninteger(int64)
Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "templateVersion": 0
}

Update Venue Template

Request

Update venue template.

Path
venueTemplateIdstringrequired
Body
required
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
isTemplateboolean
templateVersioninteger(int64)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "templateVersion": 0
}

Responses

Accepted

Body
requestIdstring
responseobject(VenueView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "address": { … },
    "tags": [ … ],
    "isTemplate": true
  }
}

Delete Venue Template by ID

Request

Delete venue template by ID. WARNING: Note that all network devices under this venue Template will be removed as well.

Path
venueTemplateIdstringrequired
No request payload

Responses

Accepted

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

Create Venue Template

Request

Create venue template.

Body
required
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
isTemplateboolean
templateVersioninteger(int64)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "templateVersion": 0
}

Responses

Accepted

Body
requestIdstring
responseobject(VenueView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "address": { … },
    "tags": [ … ],
    "isTemplate": true
  }
}

Floor Plan

Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning).

Operations

Venue

Manage venue.

Operations