SO_GetMultiActionSignOnURL

This Legacy API is available in OLSA v8 for backward compatibility. For OLSA v8, it is recommended that you use the SO_GetMultiActionSignOnURLExtended service which is enhanced for custom user profile fields, and provides access to the Skillport Limited view for Book and Video assets.

This web service returns a launch URL that brings the specified user into the SkillPort environment's Home, Catalog, or My Plan screen. It can also bring the user in a summary screen for a specified asset or launch the specified asset itself. For more information about Launch URLs, see Web Services and Launch URLs.

You can extract the nativid or assetid from the book bin and then apply the result to a SignOn, SARMA, or RO launch.

For the following types of assets, actionType=”summary” brings the user in the same location as actionType=”launch”:

• AddOns
• Knowledge Centers
• Learning Programs
• Books24x7

This function supports the All-user-attributes option of the automatic-user-registration-or-update capability. For more information, see Automatic User Registration or Update. Note that super administrators cannot be created, edited, or modified using this web service.

Note: If you are using OLSA with Privacy Support enabled, when invoking this web service, you must specify the login name of a user created using the UM_CreateUser web service, not the login name of a user created in SkillPort. This is because a hashed login name is required by this web service, and only OLSA (not SkillPort) creates this type of login name.

Creating or Modifying Existing Users

Creating a new user sets the user attribute active to true for this user. New users are created as active users, which allows the returned URL to work. Modifying an existing user maintains the active attribute.

Inputs

• customerId - String identifies the customer of OLSA environment.
• userName - Login name of the user. The user name is converted to lowercase before it is validated. The user name cannot start with an apostrophe (') or a dash (-). Neither non-breaking white spaces (space, tab, new line) nor double-byte characters (for example, Japanese or Chinese characters) are allowed.
  • Characters allowed: abcdefghijklmnopqrstuvwxyz0123456789@$_.~'-
  • Characters not allowed: <> [ ] ( ) ; \ /

    Note: There exists a list of reserved words that you cannot use (doing so produces an error). The following are the most common: add, all, block, count, down, force, link, mount, off, simple, tag, up.

• actionType - Multi Action Sign on type: home, myplan, catalog, summary, launch
• assetId- Unique identifier for asset within the database. Use the assettype and the nativeid for purposes of identifying and launching the asset. Use this only for an actionType of summary or launch.
• password - Password for the login userName.
• firstName - User's first name
• lastName - User's last name
• email - User's email address
• manager -
• authType - (Optional) The role of the user. Specify one of the following:
  • End-User
  • Manager
  • Admin
  • Company-Admin
  • Super-Admin
• groupPath - Organization code
• groupCode - A comma-separated list of groups specified by org code.
• birthDate - User's birth date
• active - The user's status. Specify "true" to activate the user or "false" to deactivate the user.
• sex - User's sex
• address1 - User's address line 1
• address2 - User's address line 2
• city - User's city
• state - User's state
• zip - User's zip code
• country - User's country
• phone - User's Telephone number
• ccNumber - User's credit card number
• ccType - User's credit card type
• ccExpr - User's credit card expiration date
• free1 - User's free field
• language - User's language preference
• newUserName - The new login name of the user. See userName for accepted characters and character exceptions.
• enable508 - 508 value for the asset. Optional. Assume user is non-508

Outputs

One of the following requested URLs:

• Home page of the SkillPort environment
• My Plan page of the SkillPort environment
• Catalog page of the SkillPort environment
• Specified Course Summary page of the SkillPort environment
• Specified asset

Additional Faults

• None

Example

The following example with the nativeid in bold, which you can extract and use.

<SearchResults … >

  <bin binname="book" …>

    <asset assetid="_ss_book:5934" … >

    …

    <nativeid>5934</nativeid>

    …

    <asset assetid="_ss_chapter:5934-1" … >

    …

    <nativeid>5934-1</nativeid>