Skip to content
/
Access Venue by ID

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/

Floor Plan

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

Operations

Venue

Manage venue.

Operations

Access Venue by ID

Request

Get venue.

Path
venueIdstringrequired
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
floorPlansArray of objects(FloorPlanView)
isTemplateboolean
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"
  ],
  "floorPlans": [
    { … }
  ],
  "isTemplate": true
}

Replace Venue

Request

Update venue.

Path
venueIdstringrequired
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
floorPlansArray of objects(FloorPlanView)
isTemplateboolean
{
  "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"
  ],
  "floorPlans": [
    { … }
  ],
  "isTemplate": true
}

Responses

Accepted

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

Revoke Venue by ID

Request

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

Path
venueIdstringrequired
No request payload

Responses

Accepted

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

Request Venue

Request

Create venue.

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
floorPlansArray of objects(FloorPlanView)
isTemplateboolean
{
  "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"
  ],
  "floorPlans": [
    { … }
  ],
  "isTemplate": true
}

Responses

Accepted

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