POST classes/{classId}/students/{userIdentifier}/join

Authorization

Access to this endpoint is granted if all following conditions are true:

  • Authenticated user passes at least one of the following conditions: Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
  • Authenticated user who is either Student

Request Information

URI Parameters

NameDescriptionTypeAdditional information
classId

string

Required
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Wse.Models.ApiProxyResponseWithParameters
NameDescriptionTypeAdditional information
Parameters

Dictionary of string [key] and string [value]

None.
Code

integer

None.
Message

string

None.
Fields

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Parameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 1,
  "Message": "sample string 2",
  "Fields": "sample string 3"
}