Change Policy Set for Pool
- Changed response : 202 Accepted
The update request has been accepted and is in progress
Changed content type :
application/json- Changed property
requestId(object)The request id.
- Changed property
Changed content type :
application/vnd.ruckus.v1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 404 Not Found
Registration pool not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Property
code(object)The code of the error.
Property
message(object)The message of the error.
Property
reason(object)The reason of the error.
Property
suggestion(object)The suggestion of the error.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Remove Policy Set from Pool
- Changed response : 202 Accepted
The remove request has been accepted and is in progress
Changed content type :
application/json- Changed property
requestId(object)The request id.
- Changed property
Changed content type :
application/vnd.ruckus.v1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 404 Not Found
Registration pool not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Import MAC Registrations to Pool
- Changed response : 202 Accepted
The registration import request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid content supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 413 Request Too Long
Payload too large
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 419 Insufficient Space On Resource
Exceed max registrations of the pool
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Get Pools by Network ID
- Added:
pageinquery
Page index starting from 0 (0..N)
- Added:
sizeinquery
The size of the page to be returned
- Added:
sortinquery
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
- Deleted:
pageableinquery
parameters for paging
- Deleted response : 404 Not Found
Registration pool not found
- Changed response : 200 OK
Registration pools
Changed content type :
application/jsonNew optional properties:
name
Added property
content(object)The list of pool items.
Added property
empty(object)Indicates whether the result set is empty.
Added property
first(object)Indicates whether the current page is the first page.
Added property
last(object)Indicates whether the current page is the last page.
Added property
number(object)The current page number.
Added property
numberOfElements(object)The number of elements on the current page.
Added property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Property
offset(object)Property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Property
empty(object)Indicates whether the result set is empty.
Property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Added property
size(object)Added property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Added property
totalElements(object)The total number of elements in the result set.
Added property
totalPages(object)The total number of pages in the result set.
Deleted property
_links(object)Deleted property
autoCleanup(object)A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Deleted property
createdDate(object)The created date of this pool.
Deleted property
defaultAccess(object)The type of default access.
Deleted property
description(object)A description of the pool.
Deleted property
expirationDate(object)If the expiration type is specified_date then this field is the related date.
Deleted property
expirationEnabled(object)If the expiration setting is enabled for new MAC registration.
Deleted property
expirationOffset(object)If the expiration type is not specified_date then this field is the offset amount.
Deleted property
expirationType(object)Defines the rule for expiration date calculation.
Deleted property
id(object)The unique identifier for this pool.
Deleted property
identityGroupId(object)The identity group of this pool.
Deleted property
identityId(object)The single identity policy of this pool.
Deleted property
isReferenced(object)This pool is referenced by an identity group and cannot be deleted.
Deleted property
name(object)The unique reference name of the pool.
Deleted property
networkCount(object)Number of networks associated with this pool.
Deleted property
policySetId(object)The policy set of this pool.
Deleted property
registrationCount(object)Number of registrations in the pool.
Deleted property
ssidRegex(object)A regex to determine which SSIDs this registration pool will allows access to.
Changed content type :
application/vnd.ruckus.v1+jsonNew optional properties:
name
Added property
content(object)The list of pool items.
Added property
empty(object)Indicates whether the result set is empty.
Added property
first(object)Indicates whether the current page is the first page.
Added property
last(object)Indicates whether the current page is the last page.
Added property
number(object)The current page number.
Added property
numberOfElements(object)The number of elements on the current page.
Added property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Added property
size(object)Added property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Added property
totalElements(object)The total number of elements in the result set.
Added property
totalPages(object)The total number of pages in the result set.
Deleted property
_links(object)Deleted property
autoCleanup(object)A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Deleted property
createdDate(object)The created date of this pool.
Deleted property
defaultAccess(object)The type of default access.
Deleted property
description(object)A description of the pool.
Deleted property
expirationDate(object)If the expiration type is specified_date then this field is the related date.
Deleted property
expirationEnabled(object)If the expiration setting is enabled for new MAC registration.
Deleted property
expirationOffset(object)If the expiration type is not specified_date then this field is the offset amount.
Deleted property
expirationType(object)Defines the rule for expiration date calculation.
Deleted property
id(object)The unique identifier for this pool.
Deleted property
identityGroupId(object)The identity group of this pool.
Deleted property
identityId(object)The single identity policy of this pool.
Deleted property
isReferenced(object)This pool is referenced by an identity group and cannot be deleted.
Deleted property
name(object)The unique reference name of the pool.
Deleted property
networkCount(object)Number of networks associated with this pool.
Deleted property
policySetId(object)The policy set of this pool.
Deleted property
registrationCount(object)Number of registrations in the pool.
Deleted property
ssidRegex(object)A regex to determine which SSIDs this registration pool will allows access to.
Search Registration Pools by Criteria
- Changed:
pageinquery
Page index starting from 0 (0..N)
- Changed content type :
application/json
Changed property
dataOption(object)The data option.
Changed property
searchCriteriaList(object)The list of search criteria.
- Changed content type :
application/vnd.ruckus.v1+json
Changed property
dataOption(object)The data option.
Changed property
searchCriteriaList(object)The list of search criteria.
- Changed response : 200 OK
Registration pools
Changed content type :
application/jsonChanged property
content(object)The list of pool items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Changed content type :
application/vnd.ruckus.v1+jsonChanged property
content(object)The list of pool items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Search MAC Registrations by Criteria
- Changed:
pageinquery
Page index starting from 0 (0..N)
- Changed content type :
application/json
Changed property
dataOption(object)The data option.
Changed property
searchCriteriaList(object)The list of search criteria.
- Changed content type :
application/vnd.ruckus.v1+json
Changed property
dataOption(object)The data option.
Changed property
searchCriteriaList(object)The list of search criteria.
- Changed response : 200 OK
Registrations
Changed content type :
application/jsonChanged property
content(object)The list of registration items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Changed content type :
application/vnd.ruckus.v1+jsonChanged property
content(object)The list of registration items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Create Pool with Identity Group
- Changed response : 202 Accepted
The registration pool create request is in progress
Changed content type :
application/json- Changed property
requestId(object)The request id.
- Changed property
Changed content type :
application/vnd.ruckus.v1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid pool content
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
List Registration Pools
- Changed:
pageinquery
Page index starting from 0 (0..N)
- Changed response : 200 OK
Registration pools
Changed content type :
application/jsonChanged property
content(object)The list of pool items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Changed content type :
application/vnd.ruckus.v1+jsonChanged property
content(object)The list of pool items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
- Changed response : 202 Accepted
The registration pool create request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid pool content
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 419 Insufficient Space On Resource
Exceed max pools per tenant
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
DELETE /macRegistrationPools/{id}
- Changed response : 200 OK
Registration pool deleted
Changed content type :
application/jsonChanged content type :
application/vnd.ruckus.v1+json
- Changed response : 202 Accepted
The registration pool delete request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid id supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
Registration pool not found
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 409 Conflict
The Registration pool associated with other resources is not allowed to be deleted
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Returns the Specific Registration Pool
- Changed response : 400 Bad Request
Invalid id supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
Registration pool not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Update a Registration Pool
- Changed response : 202 Accepted
The registration pool update request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid id supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
Registration pool not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 200 OK
Registration deleted
Changed content type :
application/jsonChanged content type :
application/vnd.ruckus.v1+json
- Changed response : 202 Accepted
The registration bulk delete request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid ids supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
List MAC Registrations in Pool
- Changed:
pageinquery
Page index starting from 0 (0..N)
- Changed response : 200 OK
Registrations
Changed content type :
application/jsonChanged property
content(object)The list of registration items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Changed content type :
application/vnd.ruckus.v1+jsonChanged property
content(object)The list of registration items.
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
first(object)Indicates whether the current page is the first page.
Changed property
last(object)Indicates whether the current page is the last page.
Changed property
number(object)The current page number.
Changed property
numberOfElements(object)The number of elements on the current page.
Changed property
totalElements(object)The total number of elements in the result set.
Changed property
totalPages(object)The total number of pages in the result set.
Changed property
pageable(object)Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.
Changed property
pageNumber(object)The page number. Page 0 is the first page, page 1 is the second page, and so on.
Changed property
pageSize(object)The number of elements per page. Determines how many items are returned in each page of results.
Changed property
paged(object)Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination.
Changed property
unpaged(object)Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied.
Changed property
sort(object)Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).
Changed property
empty(object)Indicates whether the result set is empty.
Changed property
sorted(object)Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted.
Changed property
unsorted(object)Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted.
Create MAC Registration in Pool
- Changed response : 202 Accepted
The registration create request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid content supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 419 Insufficient Space On Resource
Exceed max registrations of the pool
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 201 Created
Registration created
- Changed response : 200 OK
Registration deleted
Changed content type :
application/jsonNew optional properties:
macAddressrevoked
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
Changed content type :
application/vnd.ruckus.v1+jsonNew optional properties:
macAddressrevoked
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
- Changed response : 202 Accepted
The registration delete request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid id supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
MAC registration not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 409 Conflict
The Registration associated with other resources is not allowed to be deleted
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 400 Bad Request
Invalid id supplied
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
MAC registration not found
Changed content type :
application/jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Changed content type :
application/vnd.ruckus.v1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
Update a MAC Registration
- Changed response : 202 Accepted
The registration update request is in progress
Changed content type :
application/vnd.ruckus.v1.1+json- Changed property
requestId(object)The request id.
- Changed property
- Changed response : 400 Bad Request
Invalid id or content supplied
Changed content type :
application/jsonNew optional properties:
macAddressrevoked
Added property
debugMessage(object)The debug message of the error.
Added property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Added property
timestamp(object)The timestamp of the error.
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
Changed content type :
application/vnd.ruckus.v1+jsonNew optional properties:
macAddressrevoked
Added property
debugMessage(object)The debug message of the error.
Added property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Added property
timestamp(object)The timestamp of the error.
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.
- Changed response : 404 Not Found
MAC registration not found
Changed content type :
application/jsonNew optional properties:
macAddressrevoked
Added property
debugMessage(object)The debug message of the error.
Added property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Added property
timestamp(object)The timestamp of the error.
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
Changed content type :
application/vnd.ruckus.v1+jsonNew optional properties:
macAddressrevoked
Added property
debugMessage(object)The debug message of the error.
Added property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Added property
timestamp(object)The timestamp of the error.
Deleted property
_links(object)Deleted property
createdDate(object)The created date of this device.
Deleted property
deviceName(object)Device name
Deleted property
email(object)The email to associate with this device.
Deleted property
expirationDate(object)Indicates when this registration expires. Will derive from the pool setting if not specified.
Deleted property
id(object)The unique identifier for this MAC registration.
Deleted property
isReferenced(object)This registration is referenced by an identity and cannot be deleted.
Deleted property
location(object)The location of this device.
Deleted property
macAddress(object)The mac address for this registration. Must be provided on post, and may not be changed.
Deleted property
revoked(object)If this MAC registration is revoked or not.
Deleted property
username(object)A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.
Changed content type :
application/vnd.ruckus.v1.1+jsonAdded property
error(object)The sub error for the API.
Added property
errors(object)The list of errors.
Added property
requestId(object)The request id.
Deleted property
message(object)Deleted property
status(object)Deleted property
subErrors(object)Changed property
debugMessage(object)The debug message of the error.
Changed property
timestamp(object)The timestamp of the error.