Updates Resident Portal 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

Resident Portals

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

Operations

Adds Resident Portal

Request

Allows the user to add a resident portal.

Bodymultipart/form-data

portalobject(ResidentPortal)required

portal.idstring(uuid)

portal.namestringrequired

Resident portal name.

portal.descriptionstring

Resident portal description.

portal.portalStatusstring

Resident portal status.

Enum"DISABLED""ENABLED"

portal.uiConfigurationResidentPortalUiConfigs (object)required

ResidentPortalUiConfigs (object)

logostring(binary)

Portal logo image

favIconstring(binary)

Portal fav icon image

multipart/form-data

{
  "portal": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "portalStatus": "DISABLED",
    "uiConfiguration": {
      "type": "string",
      "access": {
        "tenantSetDpsk": true
      },
      "text": {
        "loginText": "string",
        "title": "string",
        "subTitle": "string",
        "announcements": "string",
        "helpText": "string"
      },
      "color": {
        "mainColor": "string",
        "accentColor": "string",
        "separatorColor": "string",
        "textColor": "string"
      },
      "files": {
        "logoFileName": "string",
        "favIconFileName": "string"
      }
    }
  },
  "logo": "string",
  "favIcon": "string"
}

Responses

Created

Headers

Locationstring

Url for the added resident portal

Body

requestIdstring

_linksobject(Links)

Response

{
  "requestId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Query Resident Portals

Request

Gets the list of resident portals using the specified query.

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.

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

Responses

Resident portal details.

Body

totalElementsinteger(int64)

totalPagesinteger(int32)

sizeinteger(int32)

contentArray of objects(EntityModelResidentPortal)

numberinteger(int32)

sortobject(SortObject)

pageableobject(PageableObject)

firstboolean

lastboolean

numberOfElementsinteger(int32)

emptyboolean

Response

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

Gets Resident Portal

Request

Allows the user to get a resident portal with the given id.

Path

portalIdstring(uuid)required

Resident Portal Id

No request payload

Responses

Ok

Body

idstring(uuid)

namestringrequired

Resident portal name.

descriptionstring

Resident portal description.

portalStatusstring

Resident portal status.

Enum"DISABLED""ENABLED"

venueCountinteger(int64)read-only

Number of venues using this resident portal.

uiConfigurationResidentPortalUiConfigs (object)required

ResidentPortalUiConfigs (object)

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "portalStatus": "DISABLED",
  "venueCount": 0,
  "uiConfiguration": {
    "type": "string",
    "access": { … },
    "text": { … },
    "color": { … },
    "files": { … }
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Resident Portal

Request

Allows the user to delete a resident portal with the given id.

Path

portalIdstring(uuid)required

Resident Portal Id

No request payload

Responses

Ok