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

Gets Property ConfigurationsDeprecated

Request

Gets the list of property configurations 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

Property configurations.

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

Units API

Manages units for a venue

Operations

Resident Portals

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

Operations