Skip to content
Overview/
/Resident Portal/
Changed
Last updated

Resident Portal

GET /residents/properties/{propertyId}/access
Return Type:
  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property loginText (object)

      Custom login text displayed on portal.

    • Changed property portalAllowed (object)

      Indicates if portal access is allowed.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

GET /residents/properties/{propertyId}/files/favicons
Return Type:
  • Changed response : 200 OK

Ok

  • Changed content type : image/png
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

GET /residents/properties/{propertyId}/files/{type}
Return Type:
  • Changed response : 200 OK

Ok

  • New content type : application/hal+json

  • Changed content type : image/png

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

GET /residents/properties/{propertyId}/styles
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

DELETE /residents/properties/{propertyId}/units/devices/{deviceId}
Return Type:
  • Changed response : 400 Bad Request

Missing or invalid request body

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Unit device not found for the given unit

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

POST /residents/properties/{propertyId}/units/logins
Request:
  • Changed content type : application/json
  • Changed property hashedSecret (object)

    Hashed secret used for login authentication.

Return Type:
  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property expireDateTime (object)

      Date and time when token expires.

    • Changed property serverVersion (object)

      Current version of the server.

    • Changed property token (object)

      Authentication token for portal access.

    • Changed property unitGuid (object)

      Unique identifier for the unit.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 401 Unauthorized

Unauthorized

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

DELETE /residents/properties/{propertyId}/units/users/{userId}/devices/{deviceId}
Return Type:
  • Changed response : 400 Bad Request

Missing or invalid request body

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Device not found for the given unit

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

POST /residents/properties/{propertyId}/units/users/query
Request:
  • Changed content type : application/json

  • Changed property sortDirection (object)

    Direction for sorting results (ASC/DESC).

  • Changed property sortFields (object)

    Fields to sort results by.

  • Changed property userId (object)

    Unique identifier for the unit user.

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

  • Changed property sortDirection (object)

    Direction for sorting results (ASC/DESC).

  • Changed property sortFields (object)

    Fields to sort results by.

  • Changed property userId (object)

    Unique identifier for the unit user.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

ok

  • Changed content type : application/json

    • Changed property content (object)

      List of unit user details in this page.

    • Changed property empty (object)

      Indicates if the page has no content.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of elements in the current page.

    • Changed property totalElements (object)

      Total number of elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for the request.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates if pagination is enabled.

      • Changed property unpaged (object)

        Indicates if pagination is disabled.

    • Changed property sort (object)

      Sorting information for the request.

      • Changed property empty (object)

        Indicates if no sort criteria specified.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are unsorted.

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

    • Changed property content (object)

      List of unit user details in this page.

    • Changed property empty (object)

      Indicates if the page has no content.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of elements in the current page.

    • Changed property totalElements (object)

      Total number of elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for the request.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates if pagination is enabled.

      • Changed property unpaged (object)

        Indicates if pagination is disabled.

    • Changed property sort (object)

      Sorting information for the request.

      • Changed property empty (object)

        Indicates if no sort criteria specified.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are unsorted.

GET /residents/properties/{propertyId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Property requested is not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property address (object)

      Physical address of the property.

    • Changed property description (object)

      Detailed description of the property.

    • Changed property guid (object)

      Unique identifier for the property.

    • Changed property managementEmail (object)

      Email address of property management.

    • Changed property managementName (object)

      Name of the property management company.

    • Changed property managementPhone (object)

      Phone number of property management.

    • Changed property maxUnits (object)

      Maximum number of units allowed.

    • Changed property name (object)

      Display name of the property.

    • Changed property sendEmail (object)

      Flag to send email notifications.

    • Changed property sendSms (object)

      Flag to send SMS notifications.

    • Changed property ssids (object)

      List of available network SSIDs.

GET /residents/properties/{propertyId}/uiConfigurations
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property iconFileName (object)

      Name of the icon file.

    • Changed property tenantSubtitle (object)

      Subtitle displayed on resident portal.

GET /residents/properties/{propertyId}/units
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property guestSecret (object)

      Passphrase for the unit guest.

    • Changed property guid (object)

      Unique identifier for the unit.

    • Changed property number (object)

      Name or number of the unit.

    • Changed property secret (object)

      Passphrase for the unit owner.

    • Changed property status (object)

      Current status of the unit.

    • Changed property contact (object)

      Contact details for a resident unit.

      • Changed property contactName (object)

        Name of the contact person.

      • Changed property email (object)

        Email address of the contact.

      • Changed property phoneNumber (object)

        Phone number of the contact.

PUT /residents/properties/{propertyId}/units
Request:
  • Changed content type : application/json

  • Changed property guestSecret (object)

    Passphrase for the unit guest.

  • Changed property guid (object)

    Unique identifier for the unit.

  • Changed property number (object)

    Name or number of the unit.

  • Changed property secret (object)

    Passphrase for the unit owner.

  • Changed property status (object)

    Current status of the unit.

  • Changed property contact (object)

    Contact details for a resident unit.

    • Changed property contactName (object)

      Name of the contact person.

    • Changed property email (object)

      Email address of the contact.

    • Changed property phoneNumber (object)

      Phone number of the contact.

Return Type:
  • Changed response : 400 Bad Request

Missing or invalid request body

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 404 Not Found

Unit configuration not found for the given unit id

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Unit configuration updated

  • Changed content type : application/hal+json

    • Changed property guestSecret (object)

      Passphrase for the unit guest.

    • Changed property guid (object)

      Unique identifier for the unit.

    • Changed property number (object)

      Name or number of the unit.

    • Changed property secret (object)

      Passphrase for the unit owner.

    • Changed property status (object)

      Current status of the unit.

    • Changed property contact (object)

      Contact details for a resident unit.

      • Changed property contactName (object)

        Name of the contact person.

      • Changed property email (object)

        Email address of the contact.

      • Changed property phoneNumber (object)

        Phone number of the contact.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/hal+json

    • Changed property guestSecret (object)

      Passphrase for the unit guest.

    • Changed property guid (object)

      Unique identifier for the unit.

    • Changed property number (object)

      Name or number of the unit.

    • Changed property secret (object)

      Passphrase for the unit owner.

    • Changed property status (object)

      Current status of the unit.

    • Changed property contact (object)

      Contact details for a resident unit.

      • Changed property contactName (object)

        Name of the contact person.

      • Changed property email (object)

        Email address of the contact.

      • Changed property phoneNumber (object)

        Phone number of the contact.

GET /residents/properties/{propertyId}/units/devices
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/hal+json

    • Changed property contents (object)

      List of device details.

PUT /residents/properties/{propertyId}/units/users/{userId}
Request:
  • Changed content type : application/json

  • Changed property email (object)

    Email address of the unit user.

  • Changed property passphrase (object)

    Unit user passphrase. For resetting passphrase please provide empty string in request.

  • Changed property userId (object)

    Unique identifier for the unit user.

  • Changed property userName (object)

    Display name of the unit user.

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

  • Changed property email (object)

    Email address of the unit user.

  • Changed property passphrase (object)

    Unit user passphrase. For resetting passphrase please provide empty string in request.

  • Changed property userId (object)

    Unique identifier for the unit user.

  • Changed property userName (object)

    Display name of the unit user.

Return Type:
  • Changed response : 200 OK

ok

  • Changed content type : */*

    • Added property clientAliasId (object)

      Identifier for client alias request.

    • Changed property dpskUpdateId (object)

      Identifier for DPSK update request.

    • Changed property personaUpdateId (object)

      Identifier for persona update request.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : */*

    • Added property clientAliasId (object)

      Identifier for client alias request.

    • Changed property dpskUpdateId (object)

      Identifier for DPSK update request.

    • Changed property personaUpdateId (object)

      Identifier for persona update request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

GET /residents/properties/{propertyId}/units/users/{userId}

Get unit user details

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property email (object)

      Email address of the unit user.

    • Changed property passphrase (object)

      Unit user passphrase. For resetting passphrase please provide empty string in request.

    • Changed property userId (object)

      Unique identifier for the unit user.

    • Changed property userName (object)

      Display name of the unit user.

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

    • Changed property email (object)

      Email address of the unit user.

    • Changed property passphrase (object)

      Unit user passphrase. For resetting passphrase please provide empty string in request.

    • Changed property userId (object)

      Unique identifier for the unit user.

    • Changed property userName (object)

      Display name of the unit user.

GET /residents/properties/{propertyId}/units/users/{userId}/devices

Get unit user devices

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

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

    • Changed property detailedMessage (object)

      Detailed message with additional error information.

    • Changed property message (object)

      Brief message describing the error.

    • Changed property status (object)

      HTTP status code of the error.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      Timestamp when the error occurred.

    • Changed property validationErrors (object)

      List of validation errors if applicable.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property contents (object)

      List of device details.

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

    • Changed property contents (object)

      List of device details.

Previous page
Next page