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

Get Property Configuration

Request

Gets property configuration for the requested venue Id.

Path
venueIdstringrequired

Venue Id

No request payload

Responses

Ok

Body
venueIdstring
venueNamestringrequired

Venue name.

addressobject(Address)

Venue address.

descriptionstring
personaGroupIdstringrequired

Persona group identifier.

statusstringrequired

Status of the property

Default "DISABLED"
Enum"DISABLED""ENABLED"
unitConfigobject(UnitConfigDto)

Basic configuration on property units

communicationConfigobject(CommunicationConfigDto)

Configuration for communicating unit change events

_linksobject(Links)
residentPortalIdstring(uuid)Deprecated

Resident portal identifier.

Response
{
  "venueId": "string",
  "venueName": "string",
  "address": {
    "country": "string",
    "city": "string",
    "addressLine": "string"
  },
  "description": "string",
  "personaGroupId": "string",
  "residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
  "status": "DISABLED",
  "unitConfig": {
    "type": "string",
    "residentPortalAllowed": true,
    "residentApiAllowed": true,
    "useMaxUnitCount": true,
    "maxUnitCount": 0,
    "guestAllowed": true
  },
  "communicationConfig": {
    "type": "string",
    "sendEmail": true,
    "sendSms": true,
    "unitAssignmentHtmlRegId": "string",
    "unitAssignmentTextRegId": "string",
    "unitPassphraseChangeHtmlRegId": "string",
    "unitPassphraseChangeTextRegId": "string",
    "guestPassphraseChangeHtmlRegId": "string",
    "guestPassphraseChangeTextRegId": "string",
    "portalAccessResetHtmlRegId": "string",
    "portalAccessResetTextRegId": "string",
    "portAssignmentHtmlRegId": "string",
    "portAssignmentTextRegId": "string"
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Update Property Configuration

Request

Allows the user to enable or disable property management configuration on the specified venue.

Path
venueIdstringrequired

Venue Id

Body
required

Property configuration to enable

venueIdstring
venueNamestringrequired

Venue name.

addressobject(Address)

Venue address.

descriptionstring
personaGroupIdstringrequired

Persona group identifier.

statusstringrequired

Status of the property

Default "DISABLED"
Enum"DISABLED""ENABLED"
unitConfigobject(UnitConfigDto)

Basic configuration on property units

communicationConfigobject(CommunicationConfigDto)

Configuration for communicating unit change events

residentPortalIdstring(uuid)Deprecated

Resident portal identifier.

{
  "venueId": "string",
  "venueName": "string",
  "address": {
    "country": "string",
    "city": "string",
    "addressLine": "string"
  },
  "description": "string",
  "personaGroupId": "string",
  "residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
  "status": "DISABLED",
  "unitConfig": {
    "type": "string",
    "residentPortalAllowed": true,
    "residentApiAllowed": true,
    "useMaxUnitCount": true,
    "maxUnitCount": 0,
    "guestAllowed": true
  },
  "communicationConfig": {
    "type": "string",
    "sendEmail": true,
    "sendSms": true,
    "unitAssignmentHtmlRegId": "string",
    "unitAssignmentTextRegId": "string",
    "unitPassphraseChangeHtmlRegId": "string",
    "unitPassphraseChangeTextRegId": "string",
    "guestPassphraseChangeHtmlRegId": "string",
    "guestPassphraseChangeTextRegId": "string",
    "portalAccessResetHtmlRegId": "string",
    "portalAccessResetTextRegId": "string",
    "portAssignmentHtmlRegId": "string",
    "portAssignmentTextRegId": "string"
  }
}

Responses

Accepted

Headers
Locationstring

Url for the enabled property configuration

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

Selectively Update Property Configuration

Request

Allows the user to selectively update property management configuration on the specified venue.

Path
venueIdstringrequired

Venue Id

Bodyapplication/jsonrequired

Property configuration to enable

venueIdstring
venueNamestringrequired

Venue name.

addressobject(Address)

Venue address.

descriptionstring
personaGroupIdstringrequired

Persona group identifier.

statusstringrequired

Status of the property

Default "DISABLED"
Enum"DISABLED""ENABLED"
unitConfigobject(UnitConfigDto)

Basic configuration on property units

communicationConfigobject(CommunicationConfigDto)

Configuration for communicating unit change events

residentPortalIdstring(uuid)Deprecated

Resident portal identifier.

application/json
{
  "venueId": "string",
  "venueName": "string",
  "address": {
    "country": "string",
    "city": "string",
    "addressLine": "string"
  },
  "description": "string",
  "personaGroupId": "string",
  "residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da",
  "status": "DISABLED",
  "unitConfig": {
    "type": "string",
    "residentPortalAllowed": true,
    "residentApiAllowed": true,
    "useMaxUnitCount": true,
    "maxUnitCount": 0,
    "guestAllowed": true
  },
  "communicationConfig": {
    "type": "string",
    "sendEmail": true,
    "sendSms": true,
    "unitAssignmentHtmlRegId": "string",
    "unitAssignmentTextRegId": "string",
    "unitPassphraseChangeHtmlRegId": "string",
    "unitPassphraseChangeTextRegId": "string",
    "guestPassphraseChangeHtmlRegId": "string",
    "guestPassphraseChangeTextRegId": "string",
    "portalAccessResetHtmlRegId": "string",
    "portalAccessResetTextRegId": "string",
    "portAssignmentHtmlRegId": "string",
    "portAssignmentTextRegId": "string"
  }
}

Responses

Accepted

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

Update Resident Portal Assignment

Request

Allows the user to assign resident portal for the specified venue.

Path
venueIdstringrequired

Venue Id

residentPortalIdstring(uuid)required

Resident PortalId Id

No request payload

Responses

Ok

Body
venueIdstring

Resident portal identifier.

residentPortalIdstring(uuid)

Resident portal identifier.

Response
{
  "venueId": "string",
  "residentPortalId": "e8c784df-e1dd-4a2f-bf68-3c29e8c7e9da"
}

Query Property Configurations

Request

Gets the list of property configurations using the specified query.

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

Collection of property configurations.

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
}

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