Getting User Portal Settings

You can get User Portal settings with the getUserPortalSettings method.

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 User Portal is enabled.
welcomeTitle string Welcome Title displayed on User Portal.
instructionMessage string Instruction message displayed on User Portal.
showPublicContent bool True, if public content items are displayed on User Portal.
showHistoryReports bool True, if User Portal shows the History tab in the menu.
showTags bool True, if User Portal shows tags to filter content items.

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>
    <GetUserPortalSettingsRequest 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>
    </GetUserPortalSettingsRequest>
  </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>
    <GetUserPortalSettingsResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <UserPortalEnabled>true</UserPortalEnabled>
      <WelcomeTitle>Welcome title</WelcomeTitle>
      <InstructionMessage>Instruction message</InstructionMessage>
      <ShowPublicContent>true</ShowPublicContent>
      <ShowHistoryReports>true</ShowHistoryReports>
      <ShowTags>true</ShowTags>
    </GetUserPortalSettingsResult>
  </soap:Body>
</soap:Envelope>