Page tree
Skip to end of metadata
Go to start of metadata

You can get the settings of User Portal by sending the GET request to the following URL: /account/user_portal.

Permission to run the request: Account Owner, Administrator. 


Request Headers

X-Auth-Account-Url (required)Base URL of the account, e.g.
X-Auth-Email (required)Administrator e-mail address.
X-Auth-Password (required)Administrator password.

After the request has been completed, the system returns the response with Code 200. The body of the reponse will contain xml data with User Portal settings.


Possible Response Codes

403Permission deniedYou have no permission to get the setting of User Portal. Only Account Owner and Administrator have permission to send the request.
200OkThe request has been processed successfully.


Sample Request

GET /account/user_portal HTTP/1.1
X-Auth-Password: password


Sample Response

HTTP/1.1 200 OK
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
  <instructionMessage>Feel free to select any course from the categories below</instructionMessage>
  • No labels