Lists guest user names currently associated with a particular controller.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/guestUser/guestUsersOnController
Request Parameters
controllerId
Long
|
query
|
RequiredThe Id of WLAN controller to return guest users.
|
Response Parameters
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"
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/guestUser/guestUsersOnController
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
controllerId
Long
|
query
|
RequiredThe Id of WLAN controller to return guest users.
|
Response Parameters
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/v2/op/guestUser/guestUsersOnController?controllerId=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/guestUser/guestUsersOnController?controllerId=1" rootUrl="https://localhost/webacs/api/v2/op">
<guestUserNamesDTO>
<usernames>
<username>String value</username>
</usernames>
</guestUserNamesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/guestUser/guestUsersOnController.json?controllerId=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/guestUser/guestUsersOnController?controllerId=1",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"guestUserNamesDTO" : [ {
"usernames" : {
"username" : [ "String value" ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/guestUser/guestUsersOnController
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
controllerId
Long
|
query
|
RequiredThe Id of WLAN controller to return guest users.
|
Response Parameters
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/v3/op/guestUser/guestUsersOnController?controllerId=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/guestUser/guestUsersOnController?controllerId=1" rootUrl="https://localhost/webacs/api/v3/op">
<guestUserNamesDTO>
<usernames>
<username>String value</username>
<username>Another string value</username>
</usernames>
</guestUserNamesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/guestUser/guestUsersOnController.json?controllerId=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/guestUser/guestUsersOnController?controllerId=1",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"guestUserNamesDTO" : [ {
"usernames" : {
"username" : [ "String value", "Another string value" ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/guestUser/guestUsersOnController
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
controllerId
Long
|
query
|
RequiredThe Id of WLAN controller to return guest users.
|
Response Parameters
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/v4/op/guestUser/guestUsersOnController?controllerId=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/guestUser/guestUsersOnController?controllerId=1" rootUrl="https://localhost/webacs/api/v4/op">
<guestUserNamesDTO>
<usernames>
<username>String value</username>
<username>Another string value</username>
</usernames>
</guestUserNamesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/guestUser/guestUsersOnController.json?controllerId=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/guestUser/guestUsersOnController?controllerId=1",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"guestUserNamesDTO" : [ {
"usernames" : {
"username" : [ "String value", "Another string value" ]
}
} ]
}
}