GET v2/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.View.UserStateViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.
IsNewUser

boolean

None.
UserName

string

None.
PrivacyPolicyApprove

boolean

None.
ServerTime

date

None.
Registration

Collection of 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.
StudentSpeakPlusLevelInfo

string

None.

Response Formats

application/json

Sample: 
{
  "UserId": "c82100ee-aa1d-4fb6-890f-737086dbda19",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-06T20:39:53.3565721+00:00",
  "Registration": [
    {
      "Id": "728e9afb-9d21-49da-9d4b-2ff14a1fa437",
      "UserId": "fd07d752-59b5-415e-8908-fc076ae4ff54",
      "IsCurrent": true,
      "CenterId": "462f5a54-992d-49a0-9088-34c0a7dbb9b6",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d8b44f05-17ac-43d4-b5ad-51bf22311cbe",
      "EndDate": "2026-03-06T20:39:53.3409471+00:00",
      "StartDate": "2026-03-06T20:39:53.3409471+00:00",
      "SchedulePreferenceDate": "2026-03-06T20:39:53.3409471+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"
    },
    {
      "Id": "728e9afb-9d21-49da-9d4b-2ff14a1fa437",
      "UserId": "fd07d752-59b5-415e-8908-fc076ae4ff54",
      "IsCurrent": true,
      "CenterId": "462f5a54-992d-49a0-9088-34c0a7dbb9b6",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d8b44f05-17ac-43d4-b5ad-51bf22311cbe",
      "EndDate": "2026-03-06T20:39:53.3409471+00:00",
      "StartDate": "2026-03-06T20:39:53.3409471+00:00",
      "SchedulePreferenceDate": "2026-03-06T20:39:53.3409471+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": "2026-03-06T20:39:53.3409471+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9cecc2cb-4539-46fe-82a2-0fc129bb0f3b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e86408d4-b91b-4d17-980e-8c6ce50b5e82",
      "Sequence": 1,
      "AncestorCategoryId": "8b57b1e2-ad82-43f1-9c32-fd825d9c32be",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "9cecc2cb-4539-46fe-82a2-0fc129bb0f3b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e86408d4-b91b-4d17-980e-8c6ce50b5e82",
      "Sequence": 1,
      "AncestorCategoryId": "8b57b1e2-ad82-43f1-9c32-fd825d9c32be",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "a99e0cf4-2bf2-420d-81a8-548d880e503e",
    "CategoryId": "440f6f94-fe1b-484b-9f80-744abdbe0c62",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "58d24c0d-c506-4fb9-ba47-2b5f0e810043",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "58d24c0d-c506-4fb9-ba47-2b5f0e810043",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e4aa5e3a-2560-4e12-ab1d-8e419f61f305",
      "Questions": [
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        },
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e4aa5e3a-2560-4e12-ab1d-8e419f61f305",
      "Questions": [
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        },
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "364a55ad-37af-4db6-a4da-ae64b4d2dc8c",
      "ContentItemId": "e7cc6386-5b6f-4812-87c1-dbcfd5f06ad3",
      "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": "2026-03-06T20:39:53.3409471+00:00",
      "RescheduleDate": "2026-03-06T20:39:53.3409471+00:00"
    },
    {
      "Id": "364a55ad-37af-4db6-a4da-ae64b4d2dc8c",
      "ContentItemId": "e7cc6386-5b6f-4812-87c1-dbcfd5f06ad3",
      "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": "2026-03-06T20:39:53.3409471+00:00",
      "RescheduleDate": "2026-03-06T20:39:53.3409471+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}

text/json

Sample: 
{
  "UserId": "c82100ee-aa1d-4fb6-890f-737086dbda19",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-06T20:39:53.3878217+00:00",
  "Registration": [
    {
      "Id": "728e9afb-9d21-49da-9d4b-2ff14a1fa437",
      "UserId": "fd07d752-59b5-415e-8908-fc076ae4ff54",
      "IsCurrent": true,
      "CenterId": "462f5a54-992d-49a0-9088-34c0a7dbb9b6",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d8b44f05-17ac-43d4-b5ad-51bf22311cbe",
      "EndDate": "2026-03-06T20:39:53.3409471+00:00",
      "StartDate": "2026-03-06T20:39:53.3409471+00:00",
      "SchedulePreferenceDate": "2026-03-06T20:39:53.3409471+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"
    },
    {
      "Id": "728e9afb-9d21-49da-9d4b-2ff14a1fa437",
      "UserId": "fd07d752-59b5-415e-8908-fc076ae4ff54",
      "IsCurrent": true,
      "CenterId": "462f5a54-992d-49a0-9088-34c0a7dbb9b6",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d8b44f05-17ac-43d4-b5ad-51bf22311cbe",
      "EndDate": "2026-03-06T20:39:53.3409471+00:00",
      "StartDate": "2026-03-06T20:39:53.3409471+00:00",
      "SchedulePreferenceDate": "2026-03-06T20:39:53.3409471+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": "2026-03-06T20:39:53.3409471+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9cecc2cb-4539-46fe-82a2-0fc129bb0f3b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e86408d4-b91b-4d17-980e-8c6ce50b5e82",
      "Sequence": 1,
      "AncestorCategoryId": "8b57b1e2-ad82-43f1-9c32-fd825d9c32be",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "9cecc2cb-4539-46fe-82a2-0fc129bb0f3b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e86408d4-b91b-4d17-980e-8c6ce50b5e82",
      "Sequence": 1,
      "AncestorCategoryId": "8b57b1e2-ad82-43f1-9c32-fd825d9c32be",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "551cd930-ec71-4f9f-b1a5-fe9001e41b92",
          "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": "a99e0cf4-2bf2-420d-81a8-548d880e503e",
    "CategoryId": "440f6f94-fe1b-484b-9f80-744abdbe0c62",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "58d24c0d-c506-4fb9-ba47-2b5f0e810043",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "58d24c0d-c506-4fb9-ba47-2b5f0e810043",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e4aa5e3a-2560-4e12-ab1d-8e419f61f305",
      "Questions": [
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        },
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e4aa5e3a-2560-4e12-ab1d-8e419f61f305",
      "Questions": [
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        },
        {
          "Id": "1d1323ab-2da2-4f5f-a885-5d1acefced60",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "364a55ad-37af-4db6-a4da-ae64b4d2dc8c",
      "ContentItemId": "e7cc6386-5b6f-4812-87c1-dbcfd5f06ad3",
      "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": "2026-03-06T20:39:53.3409471+00:00",
      "RescheduleDate": "2026-03-06T20:39:53.3409471+00:00"
    },
    {
      "Id": "364a55ad-37af-4db6-a4da-ae64b4d2dc8c",
      "ContentItemId": "e7cc6386-5b6f-4812-87c1-dbcfd5f06ad3",
      "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": "2026-03-06T20:39:53.3409471+00:00",
      "RescheduleDate": "2026-03-06T20:39:53.3409471+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}