Skip to content
/
Updates Resident Portal C...

Property Management REST API (1.0.0)

Overview

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

Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
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

Adds Resident Portal

Request

Allows the user to add a resident portal.

Bodymultipart/form-data
portalobject(ResidentPortal)required
portal.​idstring(uuid)
portal.​namestringnon-emptyrequired

Resident portal name.

portal.​descriptionstring

Resident portal description.

portal.​portalStatusstring

Resident portal status.

Enum"DISABLED""ENABLED"
portal.​uiConfigurationResidentPortalConfig (object)required
ResidentPortalConfig (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
      },
      "color": {
        "mainColor": "string",
        "accentColor": "string",
        "separatorColor": "string",
        "textColor": "string"
      },
      "files": {
        "logoFileName": "string",
        "favIconFileName": "string"
      },
      "text": {
        "loginText": "string",
        "title": "string",
        "subTitle": "string",
        "announcements": "string",
        "helpText": "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.

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

Resident portal details.

Body
totalElementsinteger(int64)
totalPagesinteger(int32)
pageableobject(PageableObject)
firstboolean
lastboolean
sizeinteger(int32)
contentArray of objects(EntityModelResidentPortal)
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": [
    { … }
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": 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)
namestringnon-emptyrequired

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.

uiConfigurationResidentPortalConfig (object)required
ResidentPortalConfig (object)
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "portalStatus": "DISABLED",
  "venueCount": 0,
  "uiConfiguration": {
    "type": "string",
    "access": { … },
    "color": { … },
    "files": { … },
    "text": { … }
  },
  "_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

Updates Resident Portal Configurations

Request

Allows the user to selectively update resident portal configurations.

Path
portalIdstring(uuid)required

Resident Portal Id

Bodymultipart/form-data
changesobject(ResidentPortal)
logostring(binary)

Portal logo image

favIconstring(binary)

Portal fav icon image

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

Responses

Resident portal configuration updated

Body
idstring(uuid)
namestringnon-emptyrequired

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.

uiConfigurationResidentPortalConfig (object)required
ResidentPortalConfig (object)
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "portalStatus": "DISABLED",
  "venueCount": 0,
  "uiConfiguration": {
    "type": "string",
    "access": { … },
    "color": { … },
    "files": { … },
    "text": { … }
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Gets Resident Portal File

Request

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

Path
portalIdstring(uuid)required

Resident Portal Id

typestringrequired

Resident Portal file type

Enum"logo""favIcon"
No request payload

Responses

Ok

Body*/*
string(byte)

Deletes Resident Portal File

Request

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

Path
portalIdstring(uuid)required

Resident Portal Id

typestringrequired

Resident Portal file type

Enum"logo""favIcon"
No request payload

Responses

Ok

Response
No content

QoS Profile Assignment API

Manages QoS profile assignments

Operations