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": "dcd0dd27-e37b-4462-aadc-586a3d6dca5a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-20T22:48:42.9014398+00:00",
  "Registration": [
    {
      "Id": "87df18c0-b394-41b8-88b8-c1bf1ea95ad6",
      "UserId": "a843914c-c340-4096-bc78-8d01edffb83d",
      "IsCurrent": true,
      "CenterId": "45e473b4-b0b8-4754-aa25-46464a98a167",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ccdd25f9-7089-4b2f-a53e-2f5fdf583590",
      "EndDate": "2026-10-20T22:48:42.8858351+00:00",
      "StartDate": "2026-10-20T22:48:42.8858351+00:00",
      "SchedulePreferenceDate": "2026-10-20T22:48:42.8858351+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": "87df18c0-b394-41b8-88b8-c1bf1ea95ad6",
      "UserId": "a843914c-c340-4096-bc78-8d01edffb83d",
      "IsCurrent": true,
      "CenterId": "45e473b4-b0b8-4754-aa25-46464a98a167",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ccdd25f9-7089-4b2f-a53e-2f5fdf583590",
      "EndDate": "2026-10-20T22:48:42.8858351+00:00",
      "StartDate": "2026-10-20T22:48:42.8858351+00:00",
      "SchedulePreferenceDate": "2026-10-20T22:48:42.8858351+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-10-20T22:48:42.8858351+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "cdc2b213-0875-44b4-8116-cb9e554dfc04",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "0644ba5b-13f4-4da8-a054-98f04d8fe987",
      "Sequence": 1,
      "AncestorCategoryId": "64c97373-119d-4574-914d-93ee58551dbb",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "cdc2b213-0875-44b4-8116-cb9e554dfc04",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "0644ba5b-13f4-4da8-a054-98f04d8fe987",
      "Sequence": 1,
      "AncestorCategoryId": "64c97373-119d-4574-914d-93ee58551dbb",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "2d24bb90-357e-4700-bac1-357b836ecdce",
    "CategoryId": "2c4413f7-dab3-4be4-a38c-d0ab64e9e17d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "06c25313-ad6b-489f-be82-577d6b1fc92d",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "06c25313-ad6b-489f-be82-577d6b1fc92d",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d4f6b88f-1a4d-4e7c-9a3b-47a02d8360ef",
      "Questions": [
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d4f6b88f-1a4d-4e7c-9a3b-47a02d8360ef",
      "Questions": [
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "78bef2f4-27bc-4417-862d-cdf06d704793",
      "ContentItemId": "0e28f04b-8028-44c8-ae44-4a564d1c1b9a",
      "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-10-20T22:48:42.8858351+00:00",
      "RescheduleDate": "2026-10-20T22:48:42.8858351+00:00"
    },
    {
      "Id": "78bef2f4-27bc-4417-862d-cdf06d704793",
      "ContentItemId": "0e28f04b-8028-44c8-ae44-4a564d1c1b9a",
      "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-10-20T22:48:42.8858351+00:00",
      "RescheduleDate": "2026-10-20T22:48:42.8858351+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": "dcd0dd27-e37b-4462-aadc-586a3d6dca5a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-20T22:48:42.9170636+00:00",
  "Registration": [
    {
      "Id": "87df18c0-b394-41b8-88b8-c1bf1ea95ad6",
      "UserId": "a843914c-c340-4096-bc78-8d01edffb83d",
      "IsCurrent": true,
      "CenterId": "45e473b4-b0b8-4754-aa25-46464a98a167",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ccdd25f9-7089-4b2f-a53e-2f5fdf583590",
      "EndDate": "2026-10-20T22:48:42.8858351+00:00",
      "StartDate": "2026-10-20T22:48:42.8858351+00:00",
      "SchedulePreferenceDate": "2026-10-20T22:48:42.8858351+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": "87df18c0-b394-41b8-88b8-c1bf1ea95ad6",
      "UserId": "a843914c-c340-4096-bc78-8d01edffb83d",
      "IsCurrent": true,
      "CenterId": "45e473b4-b0b8-4754-aa25-46464a98a167",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ccdd25f9-7089-4b2f-a53e-2f5fdf583590",
      "EndDate": "2026-10-20T22:48:42.8858351+00:00",
      "StartDate": "2026-10-20T22:48:42.8858351+00:00",
      "SchedulePreferenceDate": "2026-10-20T22:48:42.8858351+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-10-20T22:48:42.8858351+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "cdc2b213-0875-44b4-8116-cb9e554dfc04",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "0644ba5b-13f4-4da8-a054-98f04d8fe987",
      "Sequence": 1,
      "AncestorCategoryId": "64c97373-119d-4574-914d-93ee58551dbb",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "cdc2b213-0875-44b4-8116-cb9e554dfc04",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "0644ba5b-13f4-4da8-a054-98f04d8fe987",
      "Sequence": 1,
      "AncestorCategoryId": "64c97373-119d-4574-914d-93ee58551dbb",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "7abd2b85-ffd3-47b8-b975-308dfc092c1f",
          "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": "2d24bb90-357e-4700-bac1-357b836ecdce",
    "CategoryId": "2c4413f7-dab3-4be4-a38c-d0ab64e9e17d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "06c25313-ad6b-489f-be82-577d6b1fc92d",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "06c25313-ad6b-489f-be82-577d6b1fc92d",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d4f6b88f-1a4d-4e7c-9a3b-47a02d8360ef",
      "Questions": [
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d4f6b88f-1a4d-4e7c-9a3b-47a02d8360ef",
      "Questions": [
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e6656cfe-8346-4fbb-9890-22507874c48d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "78bef2f4-27bc-4417-862d-cdf06d704793",
      "ContentItemId": "0e28f04b-8028-44c8-ae44-4a564d1c1b9a",
      "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-10-20T22:48:42.8858351+00:00",
      "RescheduleDate": "2026-10-20T22:48:42.8858351+00:00"
    },
    {
      "Id": "78bef2f4-27bc-4417-862d-cdf06d704793",
      "ContentItemId": "0e28f04b-8028-44c8-ae44-4a564d1c1b9a",
      "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-10-20T22:48:42.8858351+00:00",
      "RescheduleDate": "2026-10-20T22:48:42.8858351+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}