Getting User Portal Settings
You can get User Portal settings with the getUserPortalSettings method.
Permission to run the request: Account Owner, Administrator.
Parameters
Parameter | Type | Description |
---|---|---|
credentials (required) | credentials | Read the description of the Credentials object. |
Return Value
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
userPortalEnabled | bool | True if the user portal is enabled. |
welcomeTitle | string | Welcome Title displayed in the user portal. |
instructionMessage | string | Instruction message displayed in the user portal. |
showHistoryReports | bool | True, if the History tab is enabled in the user portal. |
coursesSortColumn | string | The way the courses are sorted in the user portal: by status, title or duration. |
Possible Errors
Text | Description |
---|---|
Permission denied | You have no permissions to get the settings of the user portal. Only the account Owner and the administrators have permissions to send the request. |
Wrong parameters | The system failed to process the request because it did not contain all necessary parameters. |
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUserPortalSettingsRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
</GetUserPortalSettingsRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetUserPortalSettingsResult>
<userPortalEnabled>true</userPortalEnabled>
<welcomeTitle>Welcome title</welcomeTitle>
<instructionMessage>Instruction message</instructionMessage>
<showHistoryReports>true</showHistoryReports>
<coursesSortColumn>status</coursesSortColumn>
</GetUserPortalSettingsResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML