Pearson
Always Learning

Overloads provide multiple ways to specify a data item in the resource request. For example, you can specify a user using the LearningStudio user ID or using the Educational Partner login information. The following are the standard overloads defined within LearningStudio, with the note that some resources may restrict which overloads are allowed - see the specific resource page for information about which overloads each resource allows.

User Identification

Following are the different methods to identify users.

User Identification Type Description
{userId} ID assigned to each user by LearningStudio when the user is initially created. User IDs are unique within the entire LearningStudio platform.
loginid={clientString}|{username} Combination of client string assigned to each Educational Partner by LearningStudio and the username assigned to each user by the Educational Partner. The combination of client string and username are unique within the entire LearningStudio platform - that is, the Educational Partner usernames are unique within the Educational Partner user set. Caution: If the Educational Partner assigns the same username to multiple users, their data will be combined as a single user within LearningStudio.

Important:The pipe character ( | ) must be URL encoded, effective October 21, 2015. This means when you make the API request, it should be:
loginid={clientString}%7C{username}
me Identifies the user authenticated via the current OAuth2 session. Is a shortcut for /users/{userId} in any API request when using OAuth 2.

Course Identification

Following are the different methods to identify courses.

Course Identification Type Description
{courseId} ID assigned to each course by LearningStudio when the course information is initially created. Course IDs are unique within the entire LearningStudio platform.
ccn={courseCallNumber} Course call number assigned to each course by the Educational Partner. A single course may have multiple assigned course call numbers. LearningStudio does not require that course call numbers be unique across the entire LearningStudio platform (different Educational Partners may use the same numbers as long as the number is unique within each Educational Partner). In this case, the LearningStudio API uses the context of the OAuth session to determine which Educational Partner owns the course call number used in the URI call. If the API cannot determine the Educational Partner from the session context, the request is denied with a "404 - Not Found" or a "403 - Forbidden" response. Caution: If the Educational Partner assigns the same course call number to multiple courses, their data will be combined as a single course within LearningStudio.
2454 reads
Always Learning
Pearson