GET users/{userIdentifier}/state

Gets the User's state information.

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
  • Authenticated user who is either StaffMember, Student, QA, ISUSTeacher, Administrator, FocusTool, ProspectWithTrial, User

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

user's identifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.Views.UserStateBackwardCompatibleViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

IsNewUser

boolean

None.

UserName

string

None.

PrivacyPolicyApprove

boolean

None.

ServerTime

date

None.

Registration

PearsonEnglish.LearningServices.Core.Models.Views.RegistrationViewModel

None.

TimeZone

PearsonEnglish.LearningServices.Core.Models.Views.TimeZoneViewModel

None.

Bookmarks

Dictionary of string [key] and PearsonEnglish.LearningServices.Core.Models.Views.ContentItemViewModel [value]

None.

CurrentCourse

PearsonEnglish.LearningServices.Core.Models.CurrentCourse

None.

Lessons

Collection of PearsonEnglish.LearningServices.Core.Models.Views.ContentItemResultViewModel

None.

Surveys

Collection of PearsonEnglish.LearningServices.Core.Models.Views.UserSurveyViewModel

None.

Sessions

Collection of PearsonEnglish.LearningServices.Core.Models.Views.UserSessionStateViewModel

None.

TotalRescheduleCount

integer

None.

StudentLevelInfo

PearsonEnglish.LearningServices.Core.Models.StudentLevelInfo

None.

Response Formats

application/json

Sample:
{
  "UserId": "2ea5ed3f-7e93-48fa-bf7e-dfc98ea1f1ef",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-11T08:19:03.4903803+00:00",
  "Registration": {
    "Id": "d9a1f9f5-d367-438b-9821-6cc8d00f5322",
    "UserId": "f3d161b0-8e66-4616-8c53-2d0314d9d535",
    "IsCurrent": true,
    "CenterId": "4f44eba1-aa02-4a98-b4ab-49c53b20faa5",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "f9ce811f-878f-4341-9e5f-8d9f2b051d8d",
    "EndDate": "2025-07-11T08:19:03.4747585+00:00",
    "StartDate": "2025-07-11T08:19:03.4747585+00:00",
    "SchedulePreferenceDate": "2025-07-11T08:19:03.4747585+00:00",
    "TypeName": "sample string 10",
    "WorkbookType": 0,
    "EnglishAnytime": true,
    "AllowSelfBooking": true,
    "RegistrationStatus": "sample string 12",
    "CourseStatus": "sample string 13",
    "StudentCurrentContractStatus": "sample string 14",
    "OnlineClassAccess": true,
    "InCenterClassAccess": true,
    "IsMembership": true,
    "IsPromo": true,
    "OnboardingAccess": true,
    "IsCrossCenterBooking": true,
    "IsTeen": true,
    "IsGroupContract": true,
    "IsB2B": true,
    "ServiceType": 1,
    "LabTeacherReferenceId": "sample string 24",
    "ConsultantReferenceId": "sample string 25"
  },
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2025-07-11T08:19:03.4747585+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c46c1bbc-555d-4cee-86fb-6c18e0cd609e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "aeff5f96-5794-4439-9b90-085e67079061",
      "Sequence": 1,
      "AncestorCategoryId": "5f41b6ae-29fb-4cda-ad0f-3fd814ea3a66",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    },
    "sample string 2": {
      "Id": "c46c1bbc-555d-4cee-86fb-6c18e0cd609e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "aeff5f96-5794-4439-9b90-085e67079061",
      "Sequence": 1,
      "AncestorCategoryId": "5f41b6ae-29fb-4cda-ad0f-3fd814ea3a66",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    }
  },
  "CurrentCourse": {
    "Id": "485f3273-06a4-4a4b-988d-ba0556d81262",
    "CategoryId": "556a740f-558d-4992-ac0f-c036f04da5bf",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ebfd9d39-6e80-42c8-bf08-653eccde745c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ebfd9d39-6e80-42c8-bf08-653eccde745c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "625490fb-437b-4c6d-b388-982cc89e74b0",
      "Questions": [
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "625490fb-437b-4c6d-b388-982cc89e74b0",
      "Questions": [
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cae72872-0c54-46f2-b8c4-903e31842e1c",
      "ContentItemId": "9a2df5f2-1642-496f-9550-67d4b0f721cb",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2025-07-11T08:19:03.4747585+00:00",
      "RescheduleDate": "2025-07-11T08:19:03.4747585+00:00"
    },
    {
      "Id": "cae72872-0c54-46f2-b8c4-903e31842e1c",
      "ContentItemId": "9a2df5f2-1642-496f-9550-67d4b0f721cb",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2025-07-11T08:19:03.4747585+00:00",
      "RescheduleDate": "2025-07-11T08:19:03.4747585+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "2ea5ed3f-7e93-48fa-bf7e-dfc98ea1f1ef",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-11T08:19:03.5372569+00:00",
  "Registration": {
    "Id": "d9a1f9f5-d367-438b-9821-6cc8d00f5322",
    "UserId": "f3d161b0-8e66-4616-8c53-2d0314d9d535",
    "IsCurrent": true,
    "CenterId": "4f44eba1-aa02-4a98-b4ab-49c53b20faa5",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "f9ce811f-878f-4341-9e5f-8d9f2b051d8d",
    "EndDate": "2025-07-11T08:19:03.4747585+00:00",
    "StartDate": "2025-07-11T08:19:03.4747585+00:00",
    "SchedulePreferenceDate": "2025-07-11T08:19:03.4747585+00:00",
    "TypeName": "sample string 10",
    "WorkbookType": 0,
    "EnglishAnytime": true,
    "AllowSelfBooking": true,
    "RegistrationStatus": "sample string 12",
    "CourseStatus": "sample string 13",
    "StudentCurrentContractStatus": "sample string 14",
    "OnlineClassAccess": true,
    "InCenterClassAccess": true,
    "IsMembership": true,
    "IsPromo": true,
    "OnboardingAccess": true,
    "IsCrossCenterBooking": true,
    "IsTeen": true,
    "IsGroupContract": true,
    "IsB2B": true,
    "ServiceType": 1,
    "LabTeacherReferenceId": "sample string 24",
    "ConsultantReferenceId": "sample string 25"
  },
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2025-07-11T08:19:03.4747585+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c46c1bbc-555d-4cee-86fb-6c18e0cd609e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "aeff5f96-5794-4439-9b90-085e67079061",
      "Sequence": 1,
      "AncestorCategoryId": "5f41b6ae-29fb-4cda-ad0f-3fd814ea3a66",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    },
    "sample string 2": {
      "Id": "c46c1bbc-555d-4cee-86fb-6c18e0cd609e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "aeff5f96-5794-4439-9b90-085e67079061",
      "Sequence": 1,
      "AncestorCategoryId": "5f41b6ae-29fb-4cda-ad0f-3fd814ea3a66",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "4715aa4a-7af1-4cd1-89b9-8f9bee7f6cc3",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    }
  },
  "CurrentCourse": {
    "Id": "485f3273-06a4-4a4b-988d-ba0556d81262",
    "CategoryId": "556a740f-558d-4992-ac0f-c036f04da5bf",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ebfd9d39-6e80-42c8-bf08-653eccde745c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ebfd9d39-6e80-42c8-bf08-653eccde745c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "625490fb-437b-4c6d-b388-982cc89e74b0",
      "Questions": [
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "625490fb-437b-4c6d-b388-982cc89e74b0",
      "Questions": [
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "eec6e77c-8d7f-4e9f-abd0-3c9af58c94d2",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cae72872-0c54-46f2-b8c4-903e31842e1c",
      "ContentItemId": "9a2df5f2-1642-496f-9550-67d4b0f721cb",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2025-07-11T08:19:03.4747585+00:00",
      "RescheduleDate": "2025-07-11T08:19:03.4747585+00:00"
    },
    {
      "Id": "cae72872-0c54-46f2-b8c4-903e31842e1c",
      "ContentItemId": "9a2df5f2-1642-496f-9550-67d4b0f721cb",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2025-07-11T08:19:03.4747585+00:00",
      "RescheduleDate": "2025-07-11T08:19:03.4747585+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}