Selectively Updates Unit Configurations

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

Gets Units for Venue

Request

Gets the list of units paged.

Path

venueIdstringnon-emptyrequired

Venue Id

Query

sizeinteger(int32)

Page size

pageinteger(int32)

The page to retrieve (starts at one).

sortstring

The field name to sort, comma seperated from the sort order (asc or desc).

No request payload

Responses

Units for venue.

Body

totalElementsinteger(int64)

totalPagesinteger(int32)

pageableobject(PageableObject)

firstboolean

lastboolean

sizeinteger(int32)

contentArray of objects

numberinteger(int32)

sortobject(SortObject)

numberOfElementsinteger(int32)

emptyboolean

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": { … }
  },
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 0,
  "empty": true
}

Adds Unit to Venue

Request

Allows the user to add a unit on the specified venue.

Path

venueIdstringnon-emptyrequired

Venue Id

Body

required

Unit to add

unitImportsstring(binary)required

{
  "unitImports": "string"
}

Responses

Accepted

Headers

Locationstring

Url for the added unit

Body

requestIdstring

Response

{
  "requestId": "string"
}

Query Units for Venue

Request

Gets the list of units using the specified query.

Path

venueIdstringnon-emptyrequired

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.

keywordstring

Search keyword.

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",
  "keyword": "string",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

Units for venue.

Body

Response

No response example

Gets Notifications for Units

Request

Allows the user to resend notifications for units with the given ids.

Path

venueIdstringnon-emptyrequired

Venue Id

Body

required

Unit ids (maximum of 100) to send notifications

Array [

string(uuid)

]

[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Responses

Ok

Gets Unit for Venue

Request

Allows the user to get a unit with the given id.

Path

venueIdstringnon-emptyrequired

Venue Id

unitIdstring(uuid)required

Unit Id

No request payload

Responses

Ok

Body

idstring(uuid)

namestring[ 0 .. 235 ] charactersrequired

Unit name.

residentobject(Resident)required

resident.namestring[ 0 .. 255 ] charactersrequired

Resident name.

resident.emailstring[ 0 .. 255 ] characters

Resident email.

resident.phoneNumberstring[ 0 .. 16 ] characters

Resident phone number.

statusstring

Unit status.

Enum"DISABLED""ENABLED"

dpsksArray of objects(DpskSettings)[ 0 .. 2 ] items

DPSK details.

accessPointobject(UnitAp)

trafficControlobject(TrafficControl)

personaIdstring(uuid)

guestPersonaIdstring(uuid)

identityCountinteger(int64)read-only

Count of associated identities

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resident": {
    "name": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "dpsks": [
    { … }
  ],
  "accessPoint": {
    "name": "string",
    "selectedPorts": [ … ]
  },
  "trafficControl": {
    "meteringProfileId": "string",
    "profileExpiry": "2019-08-24T14:15:22Z"
  },
  "personaId": "0387819c-a33e-454c-ad84-570bf53cd75f",
  "guestPersonaId": "18b4ce0f-80e0-4cf7-b6fa-bc1935214748",
  "identityCount": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Unit for Venue

Request

Allows the user to delete a unit with the given id.

Path

venueIdstringnon-emptyrequired

Venue Id

unitIdstring(uuid)required

Unit Id

No request payload

Responses

Ok

Body

requestIdstring

Response

{
  "requestId": "string"
}