Lists guest user names currently associated with a particular controller.
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/op/guestUser/guestUsersOnControllerRequest Parameters
Attribute | Source | Description |
---|---|---|
controllerId Long |
query |
RequiredThe Id of WLAN controller to return guest users. |
Response Parameters
Attribute | Description |
---|---|
username String[] |
The name of a guest user. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/guestUser/guestUsersOnController?controllerId=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/guestUser/guestUsersOnController?controllerId=1" rootUrl="https://localhost/webacs/api/v1/op">
<guestUserNamesDTO>
<usernames>
<username>String value</username>
</usernames>
</guestUserNamesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/guestUser/guestUsersOnController.json?controllerId=1
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/guestUser\/guestUsersOnController?controllerId=1",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"guestUserNamesDTO" : {
"usernames" : {
"username" : "String value"
}
}
}
}