Skip to content

Property Management REST API (1.0.0)

Overview

These APIs facilitate managing property configurations and units management for a venue.

Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Units Identity API

Manages linked identities for a unit.

Operations

Property Configuration

Retrieves property configuration for a tenant

Operations

Units API

Manages units for a venue

Operations

Gets Units for Venue

Request

Gets the list of units paged.

Path
venueIdstringrequired

Venue Id

Query
sizeinteger(int32)

Page size

pageinteger(int32)

The page to retrieve (starts at one).

sortstring

The field name to sort, comma seperated from the sort order (asc or desc).

No request payload

Responses

Units for venue.

Body
totalElementsinteger(int64)
totalPagesinteger(int32)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(SortObject)
pageableobject(PageableObject)
firstboolean
lastboolean
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

Adds Unit to Venue

Request

Allows the user to add a unit on the specified venue.

Path
venueIdstringrequired

Venue Id

Body
required

Unit to add

unitImportsstring(binary)required
{
  "unitImports": "string"
}

Responses

Accepted

Headers
Locationstring

Url for the added unit

Body
requestIdstring
Response
{
  "requestId": "string"
}

Query Units for Venue

Request

Gets the list of units using the specified query.

Path
venueIdstringrequired
Query
excludeContentboolean

Indicates that the content should be excluded from the query and only count and size data returned.

Default false
Body

Data for the requested query

fieldsArray of strings

Fields to select.

sortFieldstring

Sort field.

sortOrderstringrequired

Sorting direction.

Enum"ASC""DESC"
pageinteger(int32)required

Page number.

pageSizeinteger(int32)required

Number of pages.

filtersobject

Filter names and its values as filter.

{
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

Units for venue.

Body
Response
No response example

Gets Notifications for Units

Request

Allows the user to resend notifications for units with the given ids.

Path
venueIdstringrequired

Venue Id

Body
required

Unit ids (maximum of 100) to send notifications

Array [
string(uuid)
]
[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Responses

Ok

Gets Unit for Venue

Request

Allows the user to get a unit with the given id.

Path
venueIdstringrequired

Venue Id

unitIdstring(uuid)required

Unit Id

No request payload

Responses

Ok

Body
idstring(uuid)
namestringrequired

Unit name.

residentobject(Resident)required

Resident contact details.

resident.​namestringrequired

Resident name.

resident.​emailstring[ 0 .. 255 ] characters

Resident email.

resident.​phoneNumberstring[ 0 .. 16 ] characters

Resident phone number.

statusstring

Unit status.

Enum"DISABLED""ENABLED"
dpsksArray of objects(DpskSettings)[ 0 .. 2 ] items

DPSK details.

accessPointobject(UnitAp)

Access point details.

trafficControlobject(TrafficControl)

Traffic control profile details.

personaIdstring(uuid)
guestPersonaIdstring(uuid)
identityCountinteger(int64)read-only

Count of associated identities

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resident": {
    "name": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "dpsks": [
    { … }
  ],
  "accessPoint": {
    "name": "string",
    "selectedPorts": [ … ]
  },
  "trafficControl": {
    "meteringProfileId": "string",
    "profileExpiry": "2019-08-24T14:15:22Z"
  },
  "personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
  "guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
  "identityCount": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Unit for Venue

Request

Allows the user to delete a unit with the given id.

Path
venueIdstringrequired

Venue Id

unitIdstring(uuid)required

Unit Id

No request payload

Responses

Ok

Body
requestIdstring
Response
{
  "requestId": "string"
}

Selectively Updates Unit Configurations

Request

Allows the user to selectively update unit configurations on the specified venue.

Path
venueIdstringrequired

Venue Id

unitIdstring(uuid)required

Unit Id

Body
required

Unit to edit

idstring(uuid)
namestringrequired

Unit name.

residentobject(Resident)required

Resident contact details.

resident.​namestringrequired

Resident name.

resident.​emailstring[ 0 .. 255 ] characters

Resident email.

resident.​phoneNumberstring[ 0 .. 16 ] characters

Resident phone number.

statusstring

Unit status.

Enum"DISABLED""ENABLED"
dpsksArray of objects(DpskSettings)[ 0 .. 2 ] items

DPSK details.

accessPointobject(UnitAp)

Access point details.

trafficControlobject(TrafficControl)

Traffic control profile details.

personaIdstring(uuid)
guestPersonaIdstring(uuid)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resident": {
    "name": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "dpsks": [
    { … }
  ],
  "accessPoint": {
    "name": "string",
    "selectedPorts": [ … ]
  },
  "trafficControl": {
    "meteringProfileId": "string",
    "profileExpiry": "2019-08-24T14:15:22Z"
  },
  "personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
  "guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748"
}

Responses

Unit configuration updated

Body
requestIdstring
_linksobject(Links)
Response
{
  "requestId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Resident Portals

Manages, create and get configuration of resident portals for a tenant

Operations

QoS Profile Assignment API

Manages QoS profile assignments

Operations