You can change the user portal settings with the setUserPortalSettings method.

Permission to run the request: Account Owner, Administrator. 

 

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
userPortalEnabled (required)boolTrue if you want to enable the user portal in your account.
welcomeTitle (optional)stringWelcome text to be displayed in the user portal.
instructionMessage (optional)stringText of the introduction message to be displayed in the user portal.
showHistoryReports (optional, default:true)boolTrue if you want to show the History tab that logs all user's activities.
coursesSortColumnstring

Specify how courses are sorted in the user portal: by status, title or duration.


 

Return Value

After the request has been completed, the system returns an object with the following properties:

ParameterTypeDescription
successboolTrue if the settings have been changed.

Possible Errors

TextDescription
Permission deniedYou have no permissions to get the settings of the user portal. Only the account owner and the administrator have permissions to send the request.
Wrong parametersThe 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>
    <SetUserPortalSettingsRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
      <userPortalEnabled>true</userPortalEnabled>
      <welcomeTitle>Welcome title</welcomeTitle>
      <instructionMessage>Instruction message</instructionMessage>
      <showHistoryReports>true</showHistoryReports>
      <coursesSortColumn>status</coursesSortColumn>
    </SetUserPortalSettingsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


 

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>
    <SetUserPortalSettingsResult>
      <success>true</success>
    </SetUserPortalSettingsResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>