Skip to content

Resident Portal REST API (v0)

Overview

Resident portals are provided to the unit owners to view and update unit details and secrets. The Resident portal APIs support these functions. These provide details on the property, units and dpsk passphrases associated. The APIs also supports updates of contact details and dpsk passphrases. APIs are authenticated using a specific token associated to the unit. These tokens are generated as the unit is created.

RateLimit

For the Resident portal REST APIs the following will be true:

  • Limits are applied to each property.
  • A maximum of 100 calls can be made per second.
  • Each second 80 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Resident Portal Unit Users API

Manages users of unit associated to the resident portal

Operations

Resident Portal Configuration

Manages Resident Portal configuration.

Operations

Resident Portal Login API

Manages Resident Portal access

Operations

Resident Portal Unit API

Manages units associated to the resident portal

Operations

Gets Unit Details

Request

Gets unit details for the authenticated unit.

Path
propertyIdstring(uuid)required

Property identifier.

No request payload

Responses

Ok

Bodyapplication/hal+json
guidstring

Unit identifier.

numberstringrequired

Unit name.

descriptionstring
contactobject(UnitContactDto)

Resident contact details.

statusstring

Unit status.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Unit owner passphrase.

guestSecretstring[ 0 .. 63 ] characters

Unit guest passphrase.

_linksobject(Links)
Response
application/hal+json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Selectively Updates Unit Configurations

Request

Allows the user to selectively update unit configurations such as passphrase, contact details.

Path
propertyIdstring(uuid)required

Property identifier.

Bodyapplication/jsonrequired

Unit to edit

guidstring

Unit identifier.

numberstringrequired

Unit name.

descriptionstring
contactobject(UnitContactDto)

Resident contact details.

statusstring

Unit status.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Unit owner passphrase.

guestSecretstring[ 0 .. 63 ] characters

Unit guest passphrase.

application/json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string"
}

Responses

Unit configuration updated

Bodyapplication/hal+json
guidstring

Unit identifier.

numberstringrequired

Unit name.

descriptionstring
contactobject(UnitContactDto)

Resident contact details.

statusstring

Unit status.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Unit owner passphrase.

guestSecretstring[ 0 .. 63 ] characters

Unit guest passphrase.

_linksobject(Links)
Response
application/hal+json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Gets Unit Devices

Request

Allows the user to get all unit and guest devices with the given unit id.

Path
propertyIdstring(uuid)required

Property identifier.

Query
typestringrequired

Type of device.UNIT and GUEST are the possible values

No request payload

Responses

Ok

Bodyapplication/hal+json
contentsArray of objects(UnitDeviceDto)
_linksobject(Links)
Response
application/hal+json
{
  "contents": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Device

Request

Allows the user to selectively remove unit device on the specified unit and device MAC address.

Path
propertyIdstring(uuid)required

Property identifier.

deviceIdstringrequired

Device Identification

No request payload

Responses

Unit device removed

Response
No content

Resident Portal UI Configuration

Provides resident portal UI configuration

Operations