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/

Property Configuration

Retrieves property configuration for a tenant

Operations

Units API

Manages units for a venue

Operations

Resident Portals

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

Operations

Get Resident PortalsDeprecated

Request

Gets the list of resident portals paged.

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

Resident portal details.

Body
totalElementsinteger(int64)
totalPagesinteger(int32)
sizeinteger(int32)
contentArray of objects(EntityModelResidentPortal)
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
}

Delete Resident PortalsDeprecated

Request

Allows the user to delete resident portals with the given ids.

Bodyapplication/jsonrequired

Resident portal ids to delete

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

Responses

Ok