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.
Parameter | Description |
---|---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
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.
Code | Text | Description |
---|---|---|
403 | Permission denied | You have no permission to get the setting of User Portal. Only Account Owner and Administrator have permission to send the request. |
200 | Ok | The request has been processed successfully. |
GET /account/user_portal HTTP/1.1 Host: api.ispringonline.com X-Auth-Account-Url: http://myaccount.ispringlearn.com X-Auth-Email: email@email.com X-Auth-Password: password |
HTTP/1.1 200 OK Connection: close <?xml version="1.0" encoding="UTF-8"?> <userPortalSettings> <userPortalEnabled>true</userPortalEnabled> <welcomeTitle>Hello!</welcomeTitle> <instructionMessage>Feel free to select any course from the categories below</instructionMessage> <showHistoryReports>true</showHistoryReports> <coursesSortColumn>status</coursesSortColumn> </userPortalSettings> |