Pearson
Always Learning

This SSO Entry Point will launch a LearningStudio course and immediately show the dropbox tool. This allows quicker access to submit homework or review returned work. Note that the beta version of LS Entry has additional entry points to give teachers more specific views

For security reasons, the returned URL endpoint is valid only for a few minutes (typically, 5 minutes). Once the user accesses the URL endpoint using the session ID, the session will follow standard user access token timeouts.

See Dropbox for the resources that provide access to the dropbox (including submitting documents) in LearningStudio.

Note: This API follows the same conventions and authentication protocols as the Course APIs, including the use of overloads. You can also use the Core Library to streamline your use of this API.

Supported Roles and Authentication Protocols

Type Supported Values
Valid for Roles: Administrator, Professor, Teaching Assistant, Student
Authentication Protocols OAuth 1.0a, OAuth 2.0

API Request

API Endpoint

You will use a POST request to the following URI.

URI

/users/{userId}/courses/{courseId}/dropboxEntry{.format}

Parameters

Parameter Description Valid Values
{userId} LearningStudio User ID or relevant user overload.
  • Numeric ID issued by LearningStudio
  • loginid={clientString}|{username}
  • or replace /users/{userId} with /me (OAuth 2 only)
{courseId} LearningStudio User ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={courseCallNumber}
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Note on Using XML Format

If you designate that the response is returned in XML format, you must perform an additional step to properly format the returned URL endpoint. The XML parser automatically encodes the ampersand character (&) as & within the returned URL endpoint. You must convert the encoded character back into the literal ampersand character (i.e., URL-decode) before redirecting the user to the URL.

Request Body

Format

{
  "webEntry" : {
    "sessionId" : "{sessionId}",
    "exitUrl" : "{exitUrl}",
    "logoutUrl" : "{logoutUrl}"
  }
}

Property Descriptions

Name Description Valid Values Required?
{sessionId} Session ID to be used for subsequent transactions to the course.
  • value - Designate session ID if manual management of the session is desired. Must be unique to the user. We recommend a GUID value.
  • blank - System will auto-generate a new session ID, but will not return it.
No
{exitUrl} Redirect URL for when the user exits LearningStudio. Used for the Close or Exit button in the UI. Fully qualified URL Yes
{logoutUrl} Redirect URL for when the user logs out of LearningStudio. Used for the Logout button in the UI. Fully qualified URL Yes

API Response

HTTP Response Codes and Errors

This API returns the standard code for successful transactions. See LS Entry Error Codes for details on errors you might see with this API.

Response Body

Format

{
  "dropboxEntry": {
    "entryUrl": "{entryUrl}"
  }
}

Property Descriptions

Name Description
{entryUrl} URL to which you'll redirect the user's browser. No additional authentication or parameters are required.

Example

Request

Endpoint

POST https://api.learningstudio.com/users/12345/courses/98765/dropboxEntry

Request Body

{
  "dropboxEntry" : {
    "exitUrl" : "http://example.edu/return",
    "logoutUrl" : "http://example.edu/logout"
  }
}

Response

Body

{
   "dropboxEntry": {
       "entryUrl":"http://transferauthentication.next.ecollege.com/Main/AdminMode/TranslateToken/TranslateAndRedirectFromPSHView.ed?token={token}&redirectUrl={url}&createNewCookie=true&returnUrl=http%3a%2f%2fexample.edu%2freturn&logoutUrl=http%3a%2f%2fexample.edu%2flogout&S=3506604d55a94a638049593b011f7f97"
   }
}

Redirect

You'll send this HTTP header to your users' browser.

HTTP/1.1 302 Found
Location: http://transferauthentication.next.ecollege.com/Main/AdminMode/TranslateToken/TranslateAndRedirectFromPSHView.ed?token={token}&redirectUrl={url}&createNewCookie=true&returnUrl=http%3a%2f%2fexample.edu/return&logoutUrl=http%3a%2f%2fexample.edu/logout&S=3506604d55a94a638049593b011f7f97
2428 reads
Always Learning
Pearson