Property Management REST API (1.0.0)

Overview

These APIs facilitate managing property configurations and units management for a venue.

Download OpenAPI description

Overview

License

Servers

Generated server url

http://localhost:8080/

Manages linked identities for a unit.

Operations

Retrieves property configuration for a tenant

Operations

Manages units for a venue

Operations

Manages, create and get configuration of resident portals for a tenant

Operations

Manages QoS profile assignments

Operations

Allows the user to update QoS profile assignments.

Path

venueIdstringnon-emptyrequired

qosProfileIdstringnon-emptyrequired

Body

required

QoS profile assignment to assign

unitIdsArray of strings(uuid)non-emptyrequired

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

Accepted

Headers

Locationstring

Url for the activity status

Body

requestIdstring

Response

{
  "requestId": "string"
}