GET users/{userIdentifier}/reminders

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 is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the online center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
  • Authenticated user who is either StaffMember, Student, Administrator, ProspectWithTrial, User

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Core.Models.Reminder
NameDescriptionTypeAdditional information
Target

string

None.

Action

string

None.

TriggerTarget

string

None.

TriggerAction

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Target": "sample string 1",
    "Action": "sample string 2",
    "TriggerTarget": "sample string 3",
    "TriggerAction": "sample string 4"
  },
  {
    "Target": "sample string 1",
    "Action": "sample string 2",
    "TriggerTarget": "sample string 3",
    "TriggerAction": "sample string 4"
  }
]