Skip to content

Venues (0.2.9)

Ruckus Network Technical Documents

Overview

Rate Limit

For the 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
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud/
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/

Floor Plan

Manage floor plans.

Operations

Access Floor Plan

Request

Get floor plan by ID.

Path
venueIdstringrequired
floorPlanIdstringrequired
No request payload

Responses

OK

Body
idstring

Floor plan identifier

venueIdstring

Venue identifier

namestring[ 2 .. 64 ] charactersrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

scalesArray of objects(Scale)

Floor plan scales

Response
{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string",
  "scales": [
    { … }
  ]
}

Replace Floor Plan

Request

Update floor plan.

Path
venueIdstringrequired
floorPlanIdstringrequired
Body
required
idstring

Floor plan identifier

venueIdstring

Venue identifier

namestring[ 2 .. 64 ] charactersrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

scalesArray of objects(Scale)

Floor plan scales

{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string",
  "scales": [
    { … }
  ]
}

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseobject(FloorPlanView)

Response payload

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "venueId": "string",
    "name": "string",
    "floorNumber": 0,
    "imageId": "string",
    "imageName": "string",
    "scales": [ … ]
  }
}

Revoke Floor Plan

Request

Delete floor plan.

Path
venueIdstringrequired
floorPlanIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseany

Response payload

Response
{
  "requestId": "string",
  "response": null
}

Replace Floor Plan Scale

Request

Update floor plan scales.

Path
venueIdstringrequired
floorPlanIdstringrequired
Body
required
scalesArray of objects(Scale)

Floor plan scales

{
  "scales": [
    { … }
  ]
}

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseobject(FloorPlanScales)

Response payload

Response
{
  "requestId": "string",
  "response": {
    "scales": [ … ]
  }
}

Access Image Upload URL

Request

Get a URL where to upload a floor plan image.

Path
venueIdstringrequired
Body
required
fileExtensionstring

File extension

{
  "fileExtension": "string"
}

Responses

OK

Body
fileIdstring

File identifier

signedUrlstring

A signed URL is a URL that provides limited permission and time to make a request.

Response
{
  "fileId": "string",
  "signedUrl": "string"
}

Access Floor Plans

Request

Get floor plans by a venue ID.

Path
venueIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring

Floor plan identifier

venueIdstring

Venue identifier

namestring[ 2 .. 64 ] charactersrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

scalesArray of objects(Scale)

Floor plan scales

]
Response
[
  {
    "id": "string",
    "venueId": "string",
    "name": "string",
    "floorNumber": 0,
    "imageId": "string",
    "imageName": "string",
    "scales": [ … ]
  }
]

Request Floor Plan

Request

Create floor plan.

Path
venueIdstringrequired
Body
required
idstring

Floor plan identifier

venueIdstring

Venue identifier

namestring[ 2 .. 64 ] charactersrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

scalesArray of objects(Scale)

Floor plan scales

{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string",
  "scales": [
    { … }
  ]
}

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseobject(FloorPlanView)

Response payload

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "venueId": "string",
    "name": "string",
    "floorNumber": 0,
    "imageId": "string",
    "imageName": "string",
    "scales": [ … ]
  }
}

Query Floor Plans

Request

Get floor plans by query criteria.

Path
venueIdstringrequired
Body
pageinteger(int32)

Page number which start with 1.

pageSizeinteger(int32)

How many items within a page.

sortFieldstring

Sort field

Value"name"
sortOrderstring

Sort order

Enum"ASC""DESC"
searchStringstring

Search string

searchTargetFieldsArray of strings

Search target fields

Items Value"name"
filtersobject

Filter multiple target fields

Example: "{\"name\":[...]}"
{
  "page": 0,
  "pageSize": 0,
  "sortField": "name",
  "sortOrder": "ASC",
  "searchString": "string",
  "searchTargetFields": [
    "name"
  ],
  "filters": "{\"name\":[...]}"
}

Responses

OK

Body
totalCountinteger(int64)

Total count

pageinteger(int64)
fieldsArray of strings

Available fields

dataArray of objects(FloorPlanView)
Response
{
  "totalCount": 0,
  "page": 0,
  "fields": [
    "string"
  ],
  "data": [
    { … }
  ]
}

Access Image Download URL

Request

Get the URL where to download a floor plan image.

Path
venueIdstringrequired
fileIdstringrequired
No request payload

Responses

Returns with the signed url

Body
fileIdstring

File identifier

signedUrlstring

A signed URL is a URL that provides limited permission and time to make a request.

Response
{
  "fileId": "string",
  "signedUrl": "string"
}

Venue Template

Manage venue template.

Operations

Venue

Manage venue.

Operations