Changing User Portal Settings

You can change User Portal settings with the setUserPortalSettings method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
userPortalEnabled (required) bool True, if you want to enable User Portal for your account.
welcomeTitle (optional) string Welcome text to be displayed on User Portal.
instruction-Message (optional) string Text of the introduction message to be displayed on User Portal.
showPublicContent (optional, default: true) bool True, if you want to display public content items to users.
showHistoryReports (optional, default: true) bool True, if you want to show the History tab that logs all user's activities.
showTags (optional, default: false) bool True, if you want to let users sort displayed content items by tags.

Return Value

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

Parameter Type Description
success bool True, if the settings have been changed.

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SetUserPortalSettingsRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
      <UserPortalEnabled>true</UserPortalEnabled>
      <WelcomeTitle>Welcome title</WelcomeTitle>
      <InstructionMessage>Instruction message</InstructionMessage>
      <ShowPublicContent>true</ShowPublicContent>
      <ShowHistoryReports>true</ShowHistoryReports>
      <ShowTags>true</ShowTags>
    </SetUserPortalSettingsRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SetUserPortalSettingsResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>True</Success>
    </SetUserPortalSettingsResult>
  </soap:Body>
</soap:Envelope>