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

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

Update QoS Profile Assignment

Request

Allows the user to update QoS profile assignments.

Path
venueIdstringrequired
qosProfileIdstringrequired
Bodyrequired

QoS profile assignment to assign

unitIdsArray of strings(uuid)required

The identifier of the metering profile.

profileExpirystring(date-time)required

The expiration date for the metering profile.

{ "unitIds": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "profileExpiry": "2019-08-24T14:15:22Z" }

Responses

Accepted

Headers
Locationstring

Url for the activity status

Body
requestIdstring
Response
{ "requestId": "string" }