Skip to content
Overview/
/Property Management/
Changed
Last updated

Property Management

POST /venues/{venueId}/units/notifications
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /residentPortals/{portalId}/files/{type}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Not found

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Deleted property errors (object)
DELETE /residentPortals/{portalId}/files/{type}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
PUT /venues/{venueId}/propertyConfigs/residentPortalAssignments/{residentPortalId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Property configuration not found for the given venue id

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
PUT /venues/{venueId}/units/qosProfileAssignments/{qosProfileId}
Request:
  • Changed content type : application/json
  • Changed property unitIds (object)

    The identifier of the metering profile.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property unitIds (object)

    The identifier of the metering profile.

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
DELETE /venues/{venueId}/units/{unitId}/identities/{identityId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Deleted property errors (object)
POST /residentPortals/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter names and its values as filter.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter names and its values as filter.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
GET /venues/propertyConfigs
Return Type:
  • Changed response : 400 Bad Request

Invalid input supplied.

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
POST /venues/propertyConfigs/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter names and its values as filter.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter names and its values as filter.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
POST /venues/{venueId}/units/identities/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter names and its values as filter.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter names and its values as filter.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
POST /venues/{venueId}/units/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    Filter names and its values as filter.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    Filter names and its values as filter.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : text/csv

    • Deleted property errors (object)
DELETE /residentPortals
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Deleted property errors (object)
GET /residentPortals
Return Type:
  • Changed response : 400 Bad Request

Invalid input supplied.

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
POST /residentPortals
Request:
  • Changed content type : multipart/form-data

  • Changed property portal (object)

    • Changed property uiConfiguration (object)
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 409 Conflict

Conflict-The resident portal trying to add already exists

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
DELETE /residentPortals/{portalId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Deleted property errors (object)
GET /residentPortals/{portalId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Not found

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property uiConfiguration (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property uiConfiguration (object)
PATCH /residentPortals/{portalId}
Request:
  • Changed content type : multipart/form-data

  • Changed property changes (object)

    • Changed property uiConfiguration (object)
Return Type:
  • Changed response : 400 Bad Request

Missing or invalid request body

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Resident portal configuration not found for the given id

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 200 OK

Resident portal configuration updated

  • Changed content type : application/json

    • Changed property uiConfiguration (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property uiConfiguration (object)
GET /venues/{venueId}/propertyConfigs
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Not found

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    New optional properties:

    • venue

    • Deleted property venue (object)

      Property venue.

    • Changed property address (object)

      Venue address.

    • Changed property communicationConfig (object)

      Configuration for communicating unit change events

      • Deleted property notifyOnUnitSuspend (object)

        Notify on unit suspend.

      • Deleted property unitReactivateHtmlRegId (object)

        Unit reactivate hyper text template.

      • Deleted property unitReactivateTextRegId (object)

        Unit reactivate text template.

      • Deleted property unitSuspendHtmlRegId (object)

        Unit suspend hyper text template.

      • Deleted property unitSuspendTextRegId (object)

        Unit suspend text template.

      • Deleted property unitUserReactivateHtmlRegId (object)

        Unit user reactivate hyper text template.

      • Deleted property unitUserReactivateTextRegId (object)

        Unit user reactivate text template.

      • Deleted property unitUserSuspendHtmlRegId (object)

        Unit user suspend hyper text template.

      • Deleted property unitUserSuspendTextRegId (object)

        Unit user suspend text template.

    • Changed property unitConfig (object)

      Basic configuration on property units

  • Changed content type : application/vnd.ruckus.v1+json

    New optional properties:

    • venue

    • Deleted property venue (object)

      Property venue.

    • Changed property address (object)

      Venue address.

    • Changed property communicationConfig (object)

      Configuration for communicating unit change events

      • Deleted property notifyOnUnitSuspend (object)

        Notify on unit suspend.

      • Deleted property unitReactivateHtmlRegId (object)

        Unit reactivate hyper text template.

      • Deleted property unitReactivateTextRegId (object)

        Unit reactivate text template.

      • Deleted property unitSuspendHtmlRegId (object)

        Unit suspend hyper text template.

      • Deleted property unitSuspendTextRegId (object)

        Unit suspend text template.

      • Deleted property unitUserReactivateHtmlRegId (object)

        Unit user reactivate hyper text template.

      • Deleted property unitUserReactivateTextRegId (object)

        Unit user reactivate text template.

      • Deleted property unitUserSuspendHtmlRegId (object)

        Unit user suspend hyper text template.

      • Deleted property unitUserSuspendTextRegId (object)

        Unit user suspend text template.

    • Changed property unitConfig (object)

      Basic configuration on property units

PUT /venues/{venueId}/propertyConfigs
Request:
  • Changed content type : application/json

New optional properties:

  • venue

  • Deleted property venue (object)

    Property venue.

  • Changed property address (object)

    Venue address.

  • Changed property communicationConfig (object)

    Configuration for communicating unit change events

    • Deleted property notifyOnUnitSuspend (object)

      Notify on unit suspend.

    • Deleted property unitReactivateHtmlRegId (object)

      Unit reactivate hyper text template.

    • Deleted property unitReactivateTextRegId (object)

      Unit reactivate text template.

    • Deleted property unitSuspendHtmlRegId (object)

      Unit suspend hyper text template.

    • Deleted property unitSuspendTextRegId (object)

      Unit suspend text template.

    • Deleted property unitUserReactivateHtmlRegId (object)

      Unit user reactivate hyper text template.

    • Deleted property unitUserReactivateTextRegId (object)

      Unit user reactivate text template.

    • Deleted property unitUserSuspendHtmlRegId (object)

      Unit user suspend hyper text template.

    • Deleted property unitUserSuspendTextRegId (object)

      Unit user suspend text template.

  • Changed property unitConfig (object)

    Basic configuration on property units

  • Changed content type : application/vnd.ruckus.v1+json

New optional properties:

  • venue

  • Deleted property venue (object)

    Property venue.

  • Changed property address (object)

    Venue address.

  • Changed property communicationConfig (object)

    Configuration for communicating unit change events

    • Deleted property notifyOnUnitSuspend (object)

      Notify on unit suspend.

    • Deleted property unitReactivateHtmlRegId (object)

      Unit reactivate hyper text template.

    • Deleted property unitReactivateTextRegId (object)

      Unit reactivate text template.

    • Deleted property unitSuspendHtmlRegId (object)

      Unit suspend hyper text template.

    • Deleted property unitSuspendTextRegId (object)

      Unit suspend text template.

    • Deleted property unitUserReactivateHtmlRegId (object)

      Unit user reactivate hyper text template.

    • Deleted property unitUserReactivateTextRegId (object)

      Unit user reactivate text template.

    • Deleted property unitUserSuspendHtmlRegId (object)

      Unit user suspend hyper text template.

    • Deleted property unitUserSuspendTextRegId (object)

      Unit user suspend text template.

  • Changed property unitConfig (object)

    Basic configuration on property units

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Property configuration not found for the given venue id

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
PATCH /venues/{venueId}/propertyConfigs
Request:
  • Changed content type : application/json

New optional properties:

  • venue

  • Deleted property venue (object)

    Property venue.

  • Changed property address (object)

    Venue address.

  • Changed property communicationConfig (object)

    Configuration for communicating unit change events

    • Deleted property notifyOnUnitSuspend (object)

      Notify on unit suspend.

    • Deleted property unitReactivateHtmlRegId (object)

      Unit reactivate hyper text template.

    • Deleted property unitReactivateTextRegId (object)

      Unit reactivate text template.

    • Deleted property unitSuspendHtmlRegId (object)

      Unit suspend hyper text template.

    • Deleted property unitSuspendTextRegId (object)

      Unit suspend text template.

    • Deleted property unitUserReactivateHtmlRegId (object)

      Unit user reactivate hyper text template.

    • Deleted property unitUserReactivateTextRegId (object)

      Unit user reactivate text template.

    • Deleted property unitUserSuspendHtmlRegId (object)

      Unit user suspend hyper text template.

    • Deleted property unitUserSuspendTextRegId (object)

      Unit user suspend text template.

  • Changed property unitConfig (object)

    Basic configuration on property units

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Property configuration not found for the given venue id

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
DELETE /venues/{venueId}/units
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
GET /venues/{venueId}/units
Return Type:
  • Changed response : 400 Bad Request

Invalid input supplied.

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
POST /venues/{venueId}/units
Request:
  • Changed content type : application/json

  • Changed property name (object)

    Unit name.

  • Changed property accessPoint (object)

    Access point details.

  • Changed property resident (object)

    Resident contact details.

    • Changed property name (object)

      Resident name.

  • Changed property trafficControl (object)

    Traffic control profile details.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property name (object)

    Unit name.

  • Changed property accessPoint (object)

    Access point details.

  • Changed property resident (object)

    Resident contact details.

    • Changed property name (object)

      Resident name.

  • Changed property trafficControl (object)

    Traffic control profile details.

DELETE /venues/{venueId}/units/{unitId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
GET /venues/{venueId}/units/{unitId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/hal+json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property name (object)

      Unit name.

    • Changed property accessPoint (object)

      Access point details.

    • Changed property resident (object)

      Resident contact details.

      • Changed property name (object)

        Resident name.

    • Changed property trafficControl (object)

      Traffic control profile details.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property name (object)

      Unit name.

    • Changed property accessPoint (object)

      Access point details.

    • Changed property resident (object)

      Resident contact details.

      • Changed property name (object)

        Resident name.

    • Changed property trafficControl (object)

      Traffic control profile details.

PATCH /venues/{venueId}/units/{unitId}
Request:
  • Changed content type : application/json

  • Changed property name (object)

    Unit name.

  • Changed property accessPoint (object)

    Access point details.

  • Changed property resident (object)

    Resident contact details.

    • Changed property name (object)

      Resident name.

  • Changed property trafficControl (object)

    Traffic control profile details.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property name (object)

    Unit name.

  • Changed property accessPoint (object)

    Access point details.

  • Changed property resident (object)

    Resident contact details.

    • Changed property name (object)

      Resident name.

  • Changed property trafficControl (object)

    Traffic control profile details.

Return Type:
  • Changed response : 400 Bad Request

Missing or invalid request body

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 404 Not Found

Unit configuration not found for the given venue id

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
  • Changed response : 500 Internal Server Error

Internal error

  • Changed content type : application/json

    • Deleted property errors (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property errors (object)
Previous page
Next page