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
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

Access Resident Portal

Request

Enables user authentication and authorization.

Path
propertyIdstringrequired

Property identifier.

Bodyapplication/jsonrequired

HashedSecret

hashedSecretstring

Hash secret for login.

application/json
{ "hashedSecret": "string" }

Responses

Ok

Bodyapplication/hal+json
unitGuidstringrequired

Unit identifier.

tokenstring

Unit token.

serverVersionstring

Server version.

expireDateTimestring(date-time)

Token expiration date.

Response
application/hal+json
{ "unitGuid": "string", "token": "string", "serverVersion": "string", "expireDateTime": "2019-08-24T14:15:22Z" }

Resident Portal Unit API

Manages units associated to the resident portal

Operations

Resident Portal UI Configuration

Provides resident portal UI configuration

Operations