Client Response Examples
The following examples show the XML format of a client response.
Example: Client Response to Query for Username 'bob'
This response shows the results of a query for any sessions for username 'bob'. The response shows the request failed because no sessions were found for that username, as indicated by:
resultMessage = no session found.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'query'><attributes><attribute name = 'User-Name' value = 'bob' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010101' resultMessage = 'no session found'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Query for Any Username Using Wildcard
This example shows the response to a successful query request for all sessions with any username using the * wildcard. The response retrieved sessions for usernames: TestUser8, TestUser9, and TestUser10. All three sessions are being handled by a device with NAS-Identifier= Building1.Room1.AP1.
<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'query'><attributes><attribute name = 'User-Name' value = '*' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '00010100' resultMessage = 'request completed successfully'><sessionResults type = 'success'><sessionResult sequence = '1'><sessionData handle = '41d088e300000009'><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 8' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 8' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest></deviceRequest><deviceResponse resultCode = '00010100' resultMessage = 'request completed successfully'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '00010100' resultMessage = 'request completed successfully'></sessionResponse></sessionResult><sessionResult sequence = '2'><sessionData handle = '41f7e1780000000a'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 9' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest></deviceRequest><deviceResponse resultCode = '00010100' resultMessage = 'request completed successfully'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '00010100' resultMessage = 'request completed successfully'></sessionResponse></sessionResult><sessionResult sequence = '3'><sessionData handle = '41f7e1780000000b'><attributes><attribute name = 'User-Name' value = 'TestUser10' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 10' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 10' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest></deviceRequest><deviceResponse resultCode = '00010100' resultMessage = 'request completed successfully'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '00010100' resultMessage = 'request completed successfully'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'failure'></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Request for Action Called "foo" on Username TestUser9
This example shows the response to a client request to perform an action called "foo" on username=TestUser9. The results show that although a session was found for username TestUser9, the request failed because the action "foo" is not defined in the deviceModels.xml file for the device (NAS-Identifier= Building1.Room1.AP1) handling the session. The failure is indicated by the
resultMessge: unknown action specified in Device Control request.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'foo'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010200' resultMessage = 'Device Control request failed'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'><sessionResult sequence = '1'><sessionData handle = '41f7e1780000000a'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 9' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 9' sequence = '4'></attribute></attributes></deviceRequest><deviceResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Request for Action Called "foo" on Username TestUser99
This response shows the results to a client request to perform an action called "foo" on username=TestUser99. In this example, the request failed as indicated by:
resultMessage = 'no matching controlled device for Device Control request'. This failure indicates that the NAS handling the session is a model that has no controlledDeviceModel defined in the deviceModels.xml file.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'foo'><attributes><attribute name = 'User-Name' value = 'TestUser99' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010200' resultMessage = 'Device Control request failed'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'><sessionResult sequence = '1'><sessionData></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult sequence = '1'><deviceRequest></deviceRequest><deviceResponse resultCode = '03020302' resultMessage = 'no matching controlled device for Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020302' resultMessage = 'no matching controlled device for Device Control request'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to RADIUS Disconnect
This response shows the results to a client request to perform a disconnect action on username TestUser9. The response shows that the request timed out, as indicated by the resultMessage:
Device Control request timed out.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'disconnect'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03020202' resultMessage = 'Device Control request timed out'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'></sessionResults><sessionResults type = 'timeout'><sessionResult sequence = '1'><sessionData handle = '41f7e1780000000a'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 9' sequence = '4'></attribute></attributes></sessionData><sessionRequest><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 9' sequence = '4'></attribute></attributes></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest type="radiusRequest" address="198.186.160.84" port="3799" ><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute><attribute name = 'Funk-Realm-Name' value = 'users' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 9' sequence = '3'></attribute></attributes></deviceRequest><deviceResponse resultCode = '03020202' resultMessage = 'Device Control request timed out'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020202' resultMessage = 'Device Control request timed out'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Action Intercept
This example shows the client response to a request to perform an action called Intercept on username=TestUser9. In this example, the request failed as indicated by:
resultMessage = 'no matching controlled device for Device Control request'. This failure indicates that the NAS handling the session is a model that has no controlledDeviceModel defined in the deviceModels.xml file.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'intercept'><attributes><attribute name = 'User-Name' value = 'TestUser9' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010200' resultMessage = 'Device Control request failed'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'><sessionResult sequence = '1'><sessionData></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult sequence = '1'><deviceRequest></deviceRequest><deviceResponse resultCode = '03020302' resultMessage = 'no matching controlled device for Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020302' resultMessage = 'no matching controlled device for Device Control request'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Action Intercept
This example shows the client response to a request to perform an action called Intercept on username TestUser8. In this case a session was found, but the request failed because the action Intercept was not defined for the device handling the session, as indicated by:
resultMessage: unknown action specified in Device Control request.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'intercept'><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010200' resultMessage = 'Device Control request failed'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'><sessionResult sequence = '1'><sessionData handle = '41d088e300000009'><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 8' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 8' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 8' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 8' sequence = '4'></attribute></attributes></deviceRequest><deviceResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>Example: Client Response to Action Intercept
This example shows the client response to a request to perform an action called Intercept on any usernames beginning with: TestUser, as indicated by the * wildcard (TestUser*). In this case, an active session was found for TestUser10, but the request failed because the action Intercept was not defined for the device handling the session, as indicated by:
resultMessage: unknown action specified in Device Control request.<envelope><header/><body><clientResults><clientResult sequence = '1'><clientRequest action = 'intercept'><attributes><attribute name = 'User-Name' value = 'TestUser*' sequence = '1'></attribute></attributes></clientRequest><clientResponse resultCode = '03010200' resultMessage = 'Device Control request failed'><sessionResults type = 'success'></sessionResults><sessionResults type = 'failure'><sessionResult sequence = '1'><sessionData handle = '41f7e1780000000b'><attributes><attribute name = 'User-Name' value = 'TestUser10' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 10' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 10' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest><attributes><attribute name = 'User-Name' value = 'TestUser10' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 10' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 10' sequence = '4'></attribute></attributes></deviceRequest><deviceResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></sessionResponse></sessionResult><sessionResult sequence = '2'><sessionData handle = '41d088e300000009'><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 8' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 8' sequence = '4'></attribute></attributes></sessionData><sessionRequest></sessionRequest><deviceResults><deviceResult device = 'Building1.Room1.Ap1' sequence = '1'><deviceRequest><attributes><attribute name = 'User-Name' value = 'TestUser8' sequence = '1'></attribute><attribute name = 'NAS-Identifier' value = 'Building1.Room1.AP1' sequence = '2'></attribute><attribute name = 'Acct-Session-Id' value = 'Session 8' sequence = '3'></attribute><attribute name = 'Acct-Multi-Session-Id' value = 'Multi Session 8' sequence = '4'></attribute></attributes></deviceRequest><deviceResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></deviceResponse></deviceResult></deviceResults><sessionResponse resultCode = '03020103' resultMessage = 'unknown action specified in Device Control request'></sessionResponse></sessionResult></sessionResults><sessionResults type = 'timeout'></sessionResults><sessionResults type = 'incomplete'></sessionResults></clientResponse></clientResult></clientResults></body></envelope>