Call: <API_URL>/VCR/DisconnectUser/
Supported HTML Methods: GET
Communications Level: Server-to-Server
Result: XML
Parameters:
CID - Integer, Required, Account Id, Sample: 12345
Token - String, Required, Sample: 9C467079-FE3B-45C5-8AA5-9726397081AA
A valid session token obtain from a previous call to the Authentication namespace for the above Account Id.
RoomId - Integer, Required. The number of the classroom in which the user is in.
UserId - Integer, Required. The number identifier of the user to remove.
Reason - String, Optional. Optionally display a reason to the user upon removal. Sample: Session is over.
Sample Call
https://api30.school-network.net/vcr/removeuser/?cid=1&token=9820d124-b471-4ab6-892f-0867b8265694&roomid=1000&UID=1000&Reason=Session%20Is%20Over
Upon execution the call will return a result code which is 0 if successful or non-zero if a failure occurs.
Optionally provide private feedback to help us improve this article...
Thank you for your feedback!