Skip to content
Overview/
/Guest Service/
Changed
Last updated

Guest Service

GET /guestUsers
Parameters:
  • Changed: page in query

Page index

  • Changed: size in query

The size of the page to be returned

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property content (object)

      List of items in the current page.

    • Changed property totalElements (object)

      Total number of elements across all pages.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

POST /guestUsers
Return Type:
  • Changed response : 201 Created

Created

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      The response payload from the operation.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

DELETE /guestUsers
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      The response payload from the operation.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /portalServiceProfiles/networks

Get Network Filter

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /portalServiceProfiles/tags

Get Tags Filter

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /portalServiceProfiles/{portalServiceProfileId}/backgroundImages

Update Portal Profile Background Image

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /portalServiceProfiles/{portalServiceProfileId}/logos

Update Portal Profile Logo

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /portalServiceProfiles/{portalServiceProfileId}/photos
Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /portalServiceProfiles/{portalServiceProfileId}/poweredImages

Update Portal Profile Powered Image

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/backgroundImages

Update Portal Template Background

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/logos

Update Portal Template Logo

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/photos

Update Portal Template Photo

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

PUT /templates/portalServiceProfiles/{portalServiceProfileId}/poweredImages

Update Portal Template Powered Image

Request:

  • Changed content type : application/json

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

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

POST /networks/{networkId}/guestUsers

Import Guest Users

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 201 Created

Created

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Response for guest user import operations containing download URL and user data.

      • Changed property data (object)

        List of imported guest users.

PATCH /wifiNetworks/{wifiNetworkId}/guestUsers
Request:
  • Changed content type : application/json
  • Changed property password (object)

    Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

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

    Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

POST /wifiNetworks/{wifiNetworkId}/guestUsers
Request:
  • Changed content type : application/json

  • Changed property email (object -> object)

    Email address of the guest user.

  • Changed property notes (object)

    Additional notes or comments about the guest user.

  • Changed property expiration (object)

    Defines expiration settings for a guest user account.

    • Changed property duration (object)

      Duration value for the expiration period.

    • Changed property unit (object)

      Time unit for the expiration duration.

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

  • Changed property email (object -> object)

    Email address of the guest user.

  • Changed property notes (object)

    Additional notes or comments about the guest user.

  • Changed property expiration (object)

    Defines expiration settings for a guest user account.

    • Changed property duration (object)

      Duration value for the expiration period.

    • Changed property unit (object)

      Time unit for the expiration duration.

Return Type:
  • Changed response : 201 Created

Created

  • New content type : multipart/form-data

  • Changed content type : application/json

    • Added property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Added property response (object)

      Represents a guest user (V1 API version) with access credentials and expiration settings.

      • Property createdDate (object)

        Timestamp when the guest user was created.

      • Property deliveryMethods (object)

        At least one delivery method.

      • Property disabled (object)

        If true, this guest user will not be permitted to join the guest network.

      • Property email (object)

        Email address of the guest user.

      • Property expiration (object)

        Defines expiration settings for a guest user account.

        • Property activationType (object)

          When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

          Enum values:

          • Creation
          • Login

        • Property duration (object)

          Duration value for the expiration period.

        • Property unit (object)

          Time unit for the expiration duration.

          Enum values:

          • Minute
          • Hour
          • Day
          • Week
          • Month
          • Year
          • Never

      • Property expirationDate (object)

        Expiration date is calculated per the expiration configuration.

      • Property guestUserType (object)

        This field is not editable after creation.

        Enum value:

        • GuestPass,SelfSign,HostGuest

      • Property id (object)

      • Property lastModified (object)

        Timestamp when the guest user was last modified.

      • Property macAddresses (object)

        MAC addresses of the guest user's connected devices.

      • Property maxDevices (object)

        Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.

      • Property mobilePhoneNumber (object)

        The mobile phone number associated to the guest user.

      • Property name (object)

        The name assigned to the guest user.

      • Property notes (object)

        Additional notes or comments about the guest user.

      • Property password (object)

        The password is generated automatically by the system.

      • Property ssid (object)

        SSID of the network to which the guest connected.

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

    • Added property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Added property response (object)

      Represents a guest user (V1 API version) with access credentials and expiration settings.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

DELETE /guestUsers/{guestUserId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      The response payload from the operation.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /guestUsers/{guestUserId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property createdDate (object)

      Timestamp when the guest user was created.

    • Changed property email (object -> object)

      Email address of the guest user.

    • Changed property guestUserType (object)

      This field is not editable after creation.

      Removed enum values:

      • GuestPass
      • Anonymous
      • SelfSign
      • HostGuest
      • Directory
      • SAML

    • Changed property lastModified (object)

      Timestamp when the guest user was last modified.

    • Changed property notes (object)

      Additional notes or comments about the guest user.

    • Changed property password (object)

      The password is generated automatically by the system.

    • Changed property expiration (object)

      Defines expiration settings for a guest user account.

      • Changed property duration (object)

        Duration value for the expiration period.

      • Changed property unit (object)

        Time unit for the expiration duration.

PATCH /guestUsers/{guestUserId}
Request:
  • Changed content type : application/json
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents a guest user with access credentials and expiration settings.

      • Changed property createdDate (object)

        Timestamp when the guest user was created.

      • Changed property email (object -> object)

        Email address of the guest user.

      • Changed property guestUserType (object)

        This field is not editable after creation.

        Removed enum values:

        • GuestPass
        • Anonymous
        • SelfSign
        • HostGuest
        • Directory
        • SAML

      • Changed property lastModified (object)

        Timestamp when the guest user was last modified.

      • Changed property notes (object)

        Additional notes or comments about the guest user.

      • Changed property password (object)

        The password is generated automatically by the system.

      • Changed property expiration (object)

        Defines expiration settings for a guest user account.

        • Changed property duration (object)

          Duration value for the expiration period.

        • Changed property unit (object)

          Time unit for the expiration duration.

POST /templates/portalServiceProfiles
Request:
  • Changed content type : application/json

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

Return Type:
  • Changed response : 201 Created

Created

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

DELETE /templates/portalServiceProfiles/{portalServiceProfileId}
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /templates/portalServiceProfiles/{portalServiceProfileId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property name (object)

      Name of the portal service.

    • Changed property content (object)

      Contains portal service profile content including branding, colors, and display settings.

      • Changed property bgColor (object)

        Background color in hexadecimal format.

      • Changed property bgImage (object)

        Base64-encoded background image data.

      • Changed property bgImageChecksum (object)

        Checksum of the background image for integrity verification.

      • Changed property buttonColor (object)

        Color of interactive buttons in hexadecimal format.

      • Changed property displayLangCode (object)

        Language code for portal content display.

      • Changed property logo (object)

        Base64-encoded logo image data.

      • Changed property logoChecksum (object)

        Checksum of the logo for integrity verification.

      • Changed property logoRatio (object)

        Aspect ratio of the logo display area.

      • Changed property photo (object)

        Base64-encoded photo image data.

      • Changed property photoChecksum (object)

        Checksum of the photo for integrity verification.

      • Changed property photoRatio (object)

        Aspect ratio of the photo display area.

      • Changed property poweredBgColor (object)

        Background color for the 'powered by' section in hexadecimal format.

      • Changed property poweredColor (object)

        Text color for the 'powered by' section in hexadecimal format.

      • Changed property poweredImg (object)

        Base64-encoded 'powered by' image data.

      • Changed property poweredImgChecksum (object)

        Checksum of the 'powered by' image for integrity verification.

      • Changed property poweredImgRatio (object)

        Aspect ratio of the 'powered by' image display area.

      • Changed property poweredSize (object)

        Font size for the 'powered by' text in pixels.

      • Changed property secondaryColor (object)

        Color for the secondary text in hexadecimal format.

      • Changed property secondarySize (object)

        Font size for the secondary text in pixels.

      • Changed property secondaryText (object)

        Secondary text content for the portal.

      • Changed property termsCondition (object)

        Terms and conditions content or URL to be displayed on the portal.

      • Changed property welcomeColor (object)

        Color for the welcome text in hexadecimal format.

      • Changed property welcomeSize (object)

        Font size for the welcome text in pixels.

      • Changed property welcomeText (object)

        Text to display in the welcome section of the portal.

      • Changed property wifi4EUNetworkId (object)

        WiFi4EU network identifier for displaying WiFi4EU branding.

      • Changed property componentDisplay (object)

        Configuration for component display settings in the portal.

        • Changed property logo (object)

          Whether to display the logo component.

        • Changed property photo (object)

          Whether to display the photo component.

        • Changed property poweredBy (object)

          Whether to display the powered by component.

        • Changed property secondaryText (object)

          Whether to display the secondary text component.

        • Changed property termsConditions (object)

          Whether to display the terms and conditions component.

        • Changed property welcome (object)

          Whether to display the welcome component.

        • Changed property wifi4eu (object)

          Whether to display the WiFi4EU component.

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

    • Changed property name (object)

      Name of the portal service.

    • Changed property content (object)

      Contains portal service profile content including branding, colors, and display settings.

      • Changed property bgColor (object)

        Background color in hexadecimal format.

      • Changed property bgImage (object)

        Base64-encoded background image data.

      • Changed property bgImageChecksum (object)

        Checksum of the background image for integrity verification.

      • Changed property buttonColor (object)

        Color of interactive buttons in hexadecimal format.

      • Changed property displayLangCode (object)

        Language code for portal content display.

      • Changed property logo (object)

        Base64-encoded logo image data.

      • Changed property logoChecksum (object)

        Checksum of the logo for integrity verification.

      • Changed property logoRatio (object)

        Aspect ratio of the logo display area.

      • Changed property photo (object)

        Base64-encoded photo image data.

      • Changed property photoChecksum (object)

        Checksum of the photo for integrity verification.

      • Changed property photoRatio (object)

        Aspect ratio of the photo display area.

      • Changed property poweredBgColor (object)

        Background color for the 'powered by' section in hexadecimal format.

      • Changed property poweredColor (object)

        Text color for the 'powered by' section in hexadecimal format.

      • Changed property poweredImg (object)

        Base64-encoded 'powered by' image data.

      • Changed property poweredImgChecksum (object)

        Checksum of the 'powered by' image for integrity verification.

      • Changed property poweredImgRatio (object)

        Aspect ratio of the 'powered by' image display area.

      • Changed property poweredSize (object)

        Font size for the 'powered by' text in pixels.

      • Changed property secondaryColor (object)

        Color for the secondary text in hexadecimal format.

      • Changed property secondarySize (object)

        Font size for the secondary text in pixels.

      • Changed property secondaryText (object)

        Secondary text content for the portal.

      • Changed property termsCondition (object)

        Terms and conditions content or URL to be displayed on the portal.

      • Changed property welcomeColor (object)

        Color for the welcome text in hexadecimal format.

      • Changed property welcomeSize (object)

        Font size for the welcome text in pixels.

      • Changed property welcomeText (object)

        Text to display in the welcome section of the portal.

      • Changed property wifi4EUNetworkId (object)

        WiFi4EU network identifier for displaying WiFi4EU branding.

      • Changed property componentDisplay (object)

        Configuration for component display settings in the portal.

        • Changed property logo (object)

          Whether to display the logo component.

        • Changed property photo (object)

          Whether to display the photo component.

        • Changed property poweredBy (object)

          Whether to display the powered by component.

        • Changed property secondaryText (object)

          Whether to display the secondary text component.

        • Changed property termsConditions (object)

          Whether to display the terms and conditions component.

        • Changed property welcome (object)

          Whether to display the welcome component.

        • Changed property wifi4eu (object)

          Whether to display the WiFi4EU component.

PUT /templates/portalServiceProfiles/{portalServiceProfileId}
Request:
  • Changed content type : application/json

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

DELETE /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property createdDate (object)

      Timestamp when the guest user was created.

    • Changed property email (object -> object)

      Email address of the guest user.

    • Changed property guestUserType (object)

      This field is not editable after creation.

      Removed enum values:

      • GuestPass
      • Anonymous
      • SelfSign
      • HostGuest
      • Directory
      • SAML

    • Changed property lastModified (object)

      Timestamp when the guest user was last modified.

    • Changed property notes (object)

      Additional notes or comments about the guest user.

    • Changed property password (object)

      The password is generated automatically by the system.

    • Changed property expiration (object)

      Defines expiration settings for a guest user account.

      • Changed property duration (object)

        Duration value for the expiration period.

      • Changed property unit (object)

        Time unit for the expiration duration.

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

    • Changed property createdDate (object)

      Timestamp when the guest user was created.

    • Changed property email (object -> object)

      Email address of the guest user.

    • Changed property guestUserType (object)

      This field is not editable after creation.

      Removed enum values:

      • GuestPass
      • Anonymous
      • SelfSign
      • HostGuest
      • Directory
      • SAML

    • Changed property lastModified (object)

      Timestamp when the guest user was last modified.

    • Changed property notes (object)

      Additional notes or comments about the guest user.

    • Changed property password (object)

      The password is generated automatically by the system.

    • Changed property expiration (object)

      Defines expiration settings for a guest user account.

      • Changed property duration (object)

        Duration value for the expiration period.

      • Changed property unit (object)

        Time unit for the expiration duration.

PATCH /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}
Request:
  • Changed content type : application/json
  • Changed property password (object)

    Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

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

    Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents a guest user without ID (V1 API version) with access credentials and expiration settings.

      • Changed property createdDate (object)

        Timestamp when the guest user was created.

      • Changed property email (object -> object)

        Email address of the guest user.

      • Changed property guestUserType (object)

        This field is not editable after creation.

        Removed enum values:

        • GuestPass
        • Anonymous
        • SelfSign
        • HostGuest
        • Directory
        • SAML

      • Changed property lastModified (object)

        Timestamp when the guest user was last modified.

      • Changed property notes (object)

        Additional notes or comments about the guest user.

      • Changed property password (object)

        The password is generated automatically by the system.

      • Changed property expiration (object)

        Defines expiration settings for a guest user account.

        • Changed property duration (object)

          Duration value for the expiration period.

        • Changed property unit (object)

          Time unit for the expiration duration.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents a guest user without ID (V1 API version) with access credentials and expiration settings.

      • Changed property createdDate (object)

        Timestamp when the guest user was created.

      • Changed property email (object -> object)

        Email address of the guest user.

      • Changed property guestUserType (object)

        This field is not editable after creation.

        Removed enum values:

        • GuestPass
        • Anonymous
        • SelfSign
        • HostGuest
        • Directory
        • SAML

      • Changed property lastModified (object)

        Timestamp when the guest user was last modified.

      • Changed property notes (object)

        Additional notes or comments about the guest user.

      • Changed property password (object)

        The password is generated automatically by the system.

      • Changed property expiration (object)

        Defines expiration settings for a guest user account.

        • Changed property duration (object)

          Duration value for the expiration period.

        • Changed property unit (object)

          Time unit for the expiration duration.

DELETE /portalServiceProfiles
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      The response payload from the operation.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /portalServiceProfiles
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property content (object)

      List of items in the current page.

    • Changed property paging (object)

      Pagination information including page number, size, and total count.

      • Changed property page (object)

        Current page number (1-based).

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property totalCount (object)

        Total number of items across all pages.

POST /portalServiceProfiles
Request:
  • Changed content type : application/json

  • Changed property id (object)

    Unique identifier for the portal service profile.

  • Changed property serviceName (object)

    Name of the portal service.

  • Changed property tags (object)

    Tags associated with the portal service profile for categorization.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property id (object)

    Unique identifier for the portal service profile.

  • Changed property serviceName (object)

    Name of the portal service.

  • Changed property tags (object)

    Tags associated with the portal service profile for categorization.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 201 Created

Created

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents an entity with a unique identifier.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents an entity with a unique identifier.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents a portal service profile with configurable branding and content.

      • Changed property id (object)

        Unique identifier for the portal service profile.

      • Changed property serviceName (object)

        Name of the portal service.

      • Changed property tags (object)

        Tags associated with the portal service profile for categorization.

      • Changed property content (object)

        Contains portal service profile content including branding, colors, and display settings.

        • Changed property bgColor (object)

          Background color in hexadecimal format.

        • Changed property bgImage (object)

          Base64-encoded background image data.

        • Changed property bgImageChecksum (object)

          Checksum of the background image for integrity verification.

        • Changed property buttonColor (object)

          Color of interactive buttons in hexadecimal format.

        • Changed property displayLangCode (object)

          Language code for portal content display.

        • Changed property logo (object)

          Base64-encoded logo image data.

        • Changed property logoChecksum (object)

          Checksum of the logo for integrity verification.

        • Changed property logoRatio (object)

          Aspect ratio of the logo display area.

        • Changed property photo (object)

          Base64-encoded photo image data.

        • Changed property photoChecksum (object)

          Checksum of the photo for integrity verification.

        • Changed property photoRatio (object)

          Aspect ratio of the photo display area.

        • Changed property poweredBgColor (object)

          Background color for the 'powered by' section in hexadecimal format.

        • Changed property poweredColor (object)

          Text color for the 'powered by' section in hexadecimal format.

        • Changed property poweredImg (object)

          Base64-encoded 'powered by' image data.

        • Changed property poweredImgChecksum (object)

          Checksum of the 'powered by' image for integrity verification.

        • Changed property poweredImgRatio (object)

          Aspect ratio of the 'powered by' image display area.

        • Changed property poweredSize (object)

          Font size for the 'powered by' text in pixels.

        • Changed property secondaryColor (object)

          Color for the secondary text in hexadecimal format.

        • Changed property secondarySize (object)

          Font size for the secondary text in pixels.

        • Changed property secondaryText (object)

          Secondary text content for the portal.

        • Changed property termsCondition (object)

          Terms and conditions content or URL to be displayed on the portal.

        • Changed property welcomeColor (object)

          Color for the welcome text in hexadecimal format.

        • Changed property welcomeSize (object)

          Font size for the welcome text in pixels.

        • Changed property welcomeText (object)

          Text to display in the welcome section of the portal.

        • Changed property wifi4EUNetworkId (object)

          WiFi4EU network identifier for displaying WiFi4EU branding.

        • Changed property componentDisplay (object)

          Configuration for component display settings in the portal.

          • Changed property logo (object)

            Whether to display the logo component.

          • Changed property photo (object)

            Whether to display the photo component.

          • Changed property poweredBy (object)

            Whether to display the powered by component.

          • Changed property secondaryText (object)

            Whether to display the secondary text component.

          • Changed property termsConditions (object)

            Whether to display the terms and conditions component.

          • Changed property welcome (object)

            Whether to display the welcome component.

          • Changed property wifi4eu (object)

            Whether to display the WiFi4EU component.

DELETE /portalServiceProfiles/{portalServiceProfileId}
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

GET /portalServiceProfiles/{portalServiceProfileId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property name (object)

      Name of the portal service.

    • Changed property content (object)

      Contains portal service profile content including branding, colors, and display settings.

      • Changed property bgColor (object)

        Background color in hexadecimal format.

      • Changed property bgImage (object)

        Base64-encoded background image data.

      • Changed property bgImageChecksum (object)

        Checksum of the background image for integrity verification.

      • Changed property buttonColor (object)

        Color of interactive buttons in hexadecimal format.

      • Changed property displayLangCode (object)

        Language code for portal content display.

      • Changed property logo (object)

        Base64-encoded logo image data.

      • Changed property logoChecksum (object)

        Checksum of the logo for integrity verification.

      • Changed property logoRatio (object)

        Aspect ratio of the logo display area.

      • Changed property photo (object)

        Base64-encoded photo image data.

      • Changed property photoChecksum (object)

        Checksum of the photo for integrity verification.

      • Changed property photoRatio (object)

        Aspect ratio of the photo display area.

      • Changed property poweredBgColor (object)

        Background color for the 'powered by' section in hexadecimal format.

      • Changed property poweredColor (object)

        Text color for the 'powered by' section in hexadecimal format.

      • Changed property poweredImg (object)

        Base64-encoded 'powered by' image data.

      • Changed property poweredImgChecksum (object)

        Checksum of the 'powered by' image for integrity verification.

      • Changed property poweredImgRatio (object)

        Aspect ratio of the 'powered by' image display area.

      • Changed property poweredSize (object)

        Font size for the 'powered by' text in pixels.

      • Changed property secondaryColor (object)

        Color for the secondary text in hexadecimal format.

      • Changed property secondarySize (object)

        Font size for the secondary text in pixels.

      • Changed property secondaryText (object)

        Secondary text content for the portal.

      • Changed property termsCondition (object)

        Terms and conditions content or URL to be displayed on the portal.

      • Changed property welcomeColor (object)

        Color for the welcome text in hexadecimal format.

      • Changed property welcomeSize (object)

        Font size for the welcome text in pixels.

      • Changed property welcomeText (object)

        Text to display in the welcome section of the portal.

      • Changed property wifi4EUNetworkId (object)

        WiFi4EU network identifier for displaying WiFi4EU branding.

      • Changed property componentDisplay (object)

        Configuration for component display settings in the portal.

        • Changed property logo (object)

          Whether to display the logo component.

        • Changed property photo (object)

          Whether to display the photo component.

        • Changed property poweredBy (object)

          Whether to display the powered by component.

        • Changed property secondaryText (object)

          Whether to display the secondary text component.

        • Changed property termsConditions (object)

          Whether to display the terms and conditions component.

        • Changed property welcome (object)

          Whether to display the welcome component.

        • Changed property wifi4eu (object)

          Whether to display the WiFi4EU component.

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

    • Changed property name (object)

      Name of the portal service.

    • Changed property content (object)

      Contains portal service profile content including branding, colors, and display settings.

      • Changed property bgColor (object)

        Background color in hexadecimal format.

      • Changed property bgImage (object)

        Base64-encoded background image data.

      • Changed property bgImageChecksum (object)

        Checksum of the background image for integrity verification.

      • Changed property buttonColor (object)

        Color of interactive buttons in hexadecimal format.

      • Changed property displayLangCode (object)

        Language code for portal content display.

      • Changed property logo (object)

        Base64-encoded logo image data.

      • Changed property logoChecksum (object)

        Checksum of the logo for integrity verification.

      • Changed property logoRatio (object)

        Aspect ratio of the logo display area.

      • Changed property photo (object)

        Base64-encoded photo image data.

      • Changed property photoChecksum (object)

        Checksum of the photo for integrity verification.

      • Changed property photoRatio (object)

        Aspect ratio of the photo display area.

      • Changed property poweredBgColor (object)

        Background color for the 'powered by' section in hexadecimal format.

      • Changed property poweredColor (object)

        Text color for the 'powered by' section in hexadecimal format.

      • Changed property poweredImg (object)

        Base64-encoded 'powered by' image data.

      • Changed property poweredImgChecksum (object)

        Checksum of the 'powered by' image for integrity verification.

      • Changed property poweredImgRatio (object)

        Aspect ratio of the 'powered by' image display area.

      • Changed property poweredSize (object)

        Font size for the 'powered by' text in pixels.

      • Changed property secondaryColor (object)

        Color for the secondary text in hexadecimal format.

      • Changed property secondarySize (object)

        Font size for the secondary text in pixels.

      • Changed property secondaryText (object)

        Secondary text content for the portal.

      • Changed property termsCondition (object)

        Terms and conditions content or URL to be displayed on the portal.

      • Changed property welcomeColor (object)

        Color for the welcome text in hexadecimal format.

      • Changed property welcomeSize (object)

        Font size for the welcome text in pixels.

      • Changed property welcomeText (object)

        Text to display in the welcome section of the portal.

      • Changed property wifi4EUNetworkId (object)

        WiFi4EU network identifier for displaying WiFi4EU branding.

      • Changed property componentDisplay (object)

        Configuration for component display settings in the portal.

        • Changed property logo (object)

          Whether to display the logo component.

        • Changed property photo (object)

          Whether to display the photo component.

        • Changed property poweredBy (object)

          Whether to display the powered by component.

        • Changed property secondaryText (object)

          Whether to display the secondary text component.

        • Changed property termsConditions (object)

          Whether to display the terms and conditions component.

        • Changed property welcome (object)

          Whether to display the welcome component.

        • Changed property wifi4eu (object)

          Whether to display the WiFi4EU component.

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

    • Changed property id (object)

      Unique identifier for the portal service profile.

    • Changed property networkIds (object)

      List of network IDs associated with this portal service profile.

    • Changed property serviceName (object)

      Name of the portal service.

    • Changed property tags (object)

      Tags associated with the portal service profile for categorization.

    • Changed property content (object)

      Contains portal service profile content including branding, colors, and display settings.

      • Changed property bgColor (object)

        Background color in hexadecimal format.

      • Changed property bgImage (object)

        Base64-encoded background image data.

      • Changed property bgImageChecksum (object)

        Checksum of the background image for integrity verification.

      • Changed property buttonColor (object)

        Color of interactive buttons in hexadecimal format.

      • Changed property displayLangCode (object)

        Language code for portal content display.

      • Changed property logo (object)

        Base64-encoded logo image data.

      • Changed property logoChecksum (object)

        Checksum of the logo for integrity verification.

      • Changed property logoRatio (object)

        Aspect ratio of the logo display area.

      • Changed property photo (object)

        Base64-encoded photo image data.

      • Changed property photoChecksum (object)

        Checksum of the photo for integrity verification.

      • Changed property photoRatio (object)

        Aspect ratio of the photo display area.

      • Changed property poweredBgColor (object)

        Background color for the 'powered by' section in hexadecimal format.

      • Changed property poweredColor (object)

        Text color for the 'powered by' section in hexadecimal format.

      • Changed property poweredImg (object)

        Base64-encoded 'powered by' image data.

      • Changed property poweredImgChecksum (object)

        Checksum of the 'powered by' image for integrity verification.

      • Changed property poweredImgRatio (object)

        Aspect ratio of the 'powered by' image display area.

      • Changed property poweredSize (object)

        Font size for the 'powered by' text in pixels.

      • Changed property secondaryColor (object)

        Color for the secondary text in hexadecimal format.

      • Changed property secondarySize (object)

        Font size for the secondary text in pixels.

      • Changed property secondaryText (object)

        Secondary text content for the portal.

      • Changed property termsCondition (object)

        Terms and conditions content or URL to be displayed on the portal.

      • Changed property welcomeColor (object)

        Color for the welcome text in hexadecimal format.

      • Changed property welcomeSize (object)

        Font size for the welcome text in pixels.

      • Changed property welcomeText (object)

        Text to display in the welcome section of the portal.

      • Changed property wifi4EUNetworkId (object)

        WiFi4EU network identifier for displaying WiFi4EU branding.

      • Changed property componentDisplay (object)

        Configuration for component display settings in the portal.

        • Changed property logo (object)

          Whether to display the logo component.

        • Changed property photo (object)

          Whether to display the photo component.

        • Changed property poweredBy (object)

          Whether to display the powered by component.

        • Changed property secondaryText (object)

          Whether to display the secondary text component.

        • Changed property termsConditions (object)

          Whether to display the terms and conditions component.

        • Changed property welcome (object)

          Whether to display the welcome component.

        • Changed property wifi4eu (object)

          Whether to display the WiFi4EU component.

PUT /portalServiceProfiles/{portalServiceProfileId}
Request:
  • Changed content type : application/json

  • Changed property id (object)

    Unique identifier for the portal service profile.

  • Changed property serviceName (object)

    Name of the portal service.

  • Changed property tags (object)

    Tags associated with the portal service profile for categorization.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property id (object)

    Unique identifier for the portal service profile.

  • Changed property serviceName (object)

    Name of the portal service.

  • Changed property tags (object)

    Tags associated with the portal service profile for categorization.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

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

  • Changed property name (object)

    Name of the portal service.

  • Changed property content (object)

    Contains portal service profile content including branding, colors, and display settings.

    • Changed property bgColor (object)

      Background color in hexadecimal format.

    • Changed property bgImage (object)

      Base64-encoded background image data.

    • Changed property bgImageChecksum (object)

      Checksum of the background image for integrity verification.

    • Changed property buttonColor (object)

      Color of interactive buttons in hexadecimal format.

    • Changed property displayLangCode (object)

      Language code for portal content display.

    • Changed property logo (object)

      Base64-encoded logo image data.

    • Changed property logoChecksum (object)

      Checksum of the logo for integrity verification.

    • Changed property logoRatio (object)

      Aspect ratio of the logo display area.

    • Changed property photo (object)

      Base64-encoded photo image data.

    • Changed property photoChecksum (object)

      Checksum of the photo for integrity verification.

    • Changed property photoRatio (object)

      Aspect ratio of the photo display area.

    • Changed property poweredBgColor (object)

      Background color for the 'powered by' section in hexadecimal format.

    • Changed property poweredColor (object)

      Text color for the 'powered by' section in hexadecimal format.

    • Changed property poweredImg (object)

      Base64-encoded 'powered by' image data.

    • Changed property poweredImgChecksum (object)

      Checksum of the 'powered by' image for integrity verification.

    • Changed property poweredImgRatio (object)

      Aspect ratio of the 'powered by' image display area.

    • Changed property poweredSize (object)

      Font size for the 'powered by' text in pixels.

    • Changed property secondaryColor (object)

      Color for the secondary text in hexadecimal format.

    • Changed property secondarySize (object)

      Font size for the secondary text in pixels.

    • Changed property secondaryText (object)

      Secondary text content for the portal.

    • Changed property termsCondition (object)

      Terms and conditions content or URL to be displayed on the portal.

    • Changed property welcomeColor (object)

      Color for the welcome text in hexadecimal format.

    • Changed property welcomeSize (object)

      Font size for the welcome text in pixels.

    • Changed property welcomeText (object)

      Text to display in the welcome section of the portal.

    • Changed property wifi4EUNetworkId (object)

      WiFi4EU network identifier for displaying WiFi4EU branding.

    • Changed property componentDisplay (object)

      Configuration for component display settings in the portal.

      • Changed property logo (object)

        Whether to display the logo component.

      • Changed property photo (object)

        Whether to display the photo component.

      • Changed property poweredBy (object)

        Whether to display the powered by component.

      • Changed property secondaryText (object)

        Whether to display the secondary text component.

      • Changed property termsConditions (object)

        Whether to display the terms and conditions component.

      • Changed property welcome (object)

        Whether to display the welcome component.

      • Changed property wifi4eu (object)

        Whether to display the WiFi4EU component.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 401 Unauthorized

The request is unauthorized.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 403 Forbidden

Forbidden.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 404 Not Found

Requested resource or related entity not found.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 422 Unprocessable Entity

Validation error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 423 Locked

Locked.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 500 Internal Server Error

Internal Server Error.

  • Changed content type : application/json

    • Changed property downloadUrl (object)

      Optional URL for downloading detailed error information.

    • Changed property errors (object)

      List of errors that occurred during the request.

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

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

    • Changed property requestId (object)

      Unique identifier that can be used to trace the request status in the activity service.

    • Changed property response (object)

      Represents a portal service profile with configurable branding and content.

      • Changed property id (object)

        Unique identifier for the portal service profile.

      • Changed property serviceName (object)

        Name of the portal service.

      • Changed property tags (object)

        Tags associated with the portal service profile for categorization.

      • Changed property content (object)

        Contains portal service profile content including branding, colors, and display settings.

        • Changed property bgColor (object)

          Background color in hexadecimal format.

        • Changed property bgImage (object)

          Base64-encoded background image data.

        • Changed property bgImageChecksum (object)

          Checksum of the background image for integrity verification.

        • Changed property buttonColor (object)

          Color of interactive buttons in hexadecimal format.

        • Changed property displayLangCode (object)

          Language code for portal content display.

        • Changed property logo (object)

          Base64-encoded logo image data.

        • Changed property logoChecksum (object)

          Checksum of the logo for integrity verification.

        • Changed property logoRatio (object)

          Aspect ratio of the logo display area.

        • Changed property photo (object)

          Base64-encoded photo image data.

        • Changed property photoChecksum (object)

          Checksum of the photo for integrity verification.

        • Changed property photoRatio (object)

          Aspect ratio of the photo display area.

        • Changed property poweredBgColor (object)

          Background color for the 'powered by' section in hexadecimal format.

        • Changed property poweredColor (object)

          Text color for the 'powered by' section in hexadecimal format.

        • Changed property poweredImg (object)

          Base64-encoded 'powered by' image data.

        • Changed property poweredImgChecksum (object)

          Checksum of the 'powered by' image for integrity verification.

        • Changed property poweredImgRatio (object)

          Aspect ratio of the 'powered by' image display area.

        • Changed property poweredSize (object)

          Font size for the 'powered by' text in pixels.

        • Changed property secondaryColor (object)

          Color for the secondary text in hexadecimal format.

        • Changed property secondarySize (object)

          Font size for the secondary text in pixels.

        • Changed property secondaryText (object)

          Secondary text content for the portal.

        • Changed property termsCondition (object)

          Terms and conditions content or URL to be displayed on the portal.

        • Changed property welcomeColor (object)

          Color for the welcome text in hexadecimal format.

        • Changed property welcomeSize (object)

          Font size for the welcome text in pixels.

        • Changed property welcomeText (object)

          Text to display in the welcome section of the portal.

        • Changed property wifi4EUNetworkId (object)

          WiFi4EU network identifier for displaying WiFi4EU branding.

        • Changed property componentDisplay (object)

          Configuration for component display settings in the portal.

          • Changed property logo (object)

            Whether to display the logo component.

          • Changed property photo (object)

            Whether to display the photo component.

          • Changed property poweredBy (object)

            Whether to display the powered by component.

          • Changed property secondaryText (object)

            Whether to display the secondary text component.

          • Changed property termsConditions (object)

            Whether to display the terms and conditions component.

          • Changed property welcome (object)

            Whether to display the welcome component.

          • Changed property wifi4eu (object)

            Whether to display the WiFi4EU component.

Previous page
Next page