Skip to content
/
Query Associated Identiti...

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

Associate Identity to Unit

Request

Allows the user to associate identities on the specified unit.

Path
venueIdstringrequired
unitIdstring(uuid)required
identityIdstring(uuid)required
No request payload

Responses

Ok

Headers
Locationstring

Url for the added unit

Body
unitIdstring(uuid)required
personaTypestringrequired
Enum"UNIT""GUEST""LINKED"
personaIdstring(uuid)required
Response
{
  "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  "personaType": "UNIT",
  "personaId": "0387819c-a33e-454c-ad84-570bf53cd75f"
}

Delete Unit Identity

Request

Allows the user to delete associated identity of the unit.

Path
venueIdstringrequired

Venue Id

unitIdstring(uuid)required

Unit Id

identityIdstring(uuid)required
No request payload

Responses

Ok

Query Associated Identities for a Unit

Request

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

Identities for venue.

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

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

QoS Profile Assignment API

Manages QoS profile assignments

Operations