Query Floor Plans

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

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

Access Floor Plan

Request

Get floor plan by ID.

Path

venueIdstringrequired

floorPlanIdstringrequired

No request payload

Responses

Body

idstring

Floor plan identifier

venueIdstring

Venue identifier

namestringrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

Response

{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string"
}

Replace Floor Plan

Request

Update floor plan.

Path

venueIdstringrequired

floorPlanIdstringrequired

Body

required

idstring

Floor plan identifier

venueIdstring

Venue identifier

namestringrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string"
}

Responses

Accepted

Body

requestIdstring

responseobject(FloorPlanView)

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "venueId": "string",
    "name": "string",
    "floorNumber": 0,
    "imageId": "string",
    "imageName": "string"
  }
}

Revoke Floor Plan

Request

Delete floor plan.

Path

venueIdstringrequired

floorPlanIdstringrequired

No request payload

Responses

Accepted

Body

requestIdstring

responseobject

Response

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

Access Image Upload URL

Request

Get a URL where to upload a floor plan image.

Path

venueIdstringrequired

Body

required

fileExtensionstring

{
  "fileExtension": "string"
}

Responses

Body

fileIdstring

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

Body

Array [

idstring

Floor plan identifier

venueIdstring

Venue identifier

namestringrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

]

Response

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

Request Floor Plan

Request

Create floor plan.

Path

venueIdstringrequired

Body

required

idstring

Floor plan identifier

venueIdstring

Venue identifier

namestringrequired

Floor plan name

floorNumberinteger(int32)required

Floor number

imageIdstringrequired

Image identifier

imageNamestringrequired

Image name

{
  "id": "string",
  "venueId": "string",
  "name": "string",
  "floorNumber": 0,
  "imageId": "string",
  "imageName": "string"
}

Responses

Accepted

Body

requestIdstring

responseobject(FloorPlanView)

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "venueId": "string",
    "name": "string",
    "floorNumber": 0,
    "imageId": "string",
    "imageName": "string"
  }
}

Query Floor Plans

Request

Get floor plans by query criteria.

Path

venueIdstringrequired

Body

pageNumberinteger(int32)

pageSizeinteger(int32)

sortBystring

Enum"FloorPlanName""VenueName"

{
  "pageNumber": 0,
  "pageSize": 0,
  "sortBy": "FloorPlanName"
}

Responses

Body

totalSizesinteger(int64)

totalPagesinteger(int64)

itemsArray of objects(FloorPlanView)

Response

{
  "totalSizes": 0,
  "totalPages": 0,
  "items": [
    { … }
  ]
}

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

signedUrlstring

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

Response

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

Venue

Manage venue.

Operations