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": "3d4f356b-c49b-499d-bacb-c5afc2280721",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-07T22:49:42.3397973+00:00",
  "Registration": [
    {
      "Id": "7435d17d-79fc-4d0e-aab8-e74c9d1964de",
      "UserId": "064e1e99-7449-4c5e-8eb0-3dd4510ce1f7",
      "IsCurrent": true,
      "CenterId": "4281bfc3-92de-4402-a5ed-74e2eeb5cecc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "8f9f12f7-3b7d-433d-91cf-154a1549f319",
      "EndDate": "2026-08-07T22:49:42.324174+00:00",
      "StartDate": "2026-08-07T22:49:42.324174+00:00",
      "SchedulePreferenceDate": "2026-08-07T22:49:42.324174+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": "7435d17d-79fc-4d0e-aab8-e74c9d1964de",
      "UserId": "064e1e99-7449-4c5e-8eb0-3dd4510ce1f7",
      "IsCurrent": true,
      "CenterId": "4281bfc3-92de-4402-a5ed-74e2eeb5cecc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "8f9f12f7-3b7d-433d-91cf-154a1549f319",
      "EndDate": "2026-08-07T22:49:42.324174+00:00",
      "StartDate": "2026-08-07T22:49:42.324174+00:00",
      "SchedulePreferenceDate": "2026-08-07T22:49:42.324174+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-08-07T22:49:42.324174+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "059b4ac6-2d0f-4cba-9d58-0a5fc899793c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "61a1fd61-cd51-45f6-a153-0265c0b81852",
      "Sequence": 1,
      "AncestorCategoryId": "dd16e60c-65d9-435d-841e-7b8a0c7c4a69",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "059b4ac6-2d0f-4cba-9d58-0a5fc899793c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "61a1fd61-cd51-45f6-a153-0265c0b81852",
      "Sequence": 1,
      "AncestorCategoryId": "dd16e60c-65d9-435d-841e-7b8a0c7c4a69",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "06dca927-823e-483c-9a8b-b1d12165a8c4",
    "CategoryId": "402b3149-1bef-4781-89a6-0dd71e84ed32",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "dc4b6bfd-b8e6-4ac3-8296-158c71ac93c6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "dc4b6bfd-b8e6-4ac3-8296-158c71ac93c6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "77f18d14-7b9c-458e-ad9f-757ff32a9e9e",
      "Questions": [
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "77f18d14-7b9c-458e-ad9f-757ff32a9e9e",
      "Questions": [
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7e3062f0-15ae-44c5-8d99-43681d6fbe59",
      "ContentItemId": "677d8d2d-d33a-4632-b8ec-85ae7e4427c2",
      "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-08-07T22:49:42.324174+00:00",
      "RescheduleDate": "2026-08-07T22:49:42.324174+00:00"
    },
    {
      "Id": "7e3062f0-15ae-44c5-8d99-43681d6fbe59",
      "ContentItemId": "677d8d2d-d33a-4632-b8ec-85ae7e4427c2",
      "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-08-07T22:49:42.324174+00:00",
      "RescheduleDate": "2026-08-07T22:49:42.324174+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": "3d4f356b-c49b-499d-bacb-c5afc2280721",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-07T22:49:42.3554213+00:00",
  "Registration": [
    {
      "Id": "7435d17d-79fc-4d0e-aab8-e74c9d1964de",
      "UserId": "064e1e99-7449-4c5e-8eb0-3dd4510ce1f7",
      "IsCurrent": true,
      "CenterId": "4281bfc3-92de-4402-a5ed-74e2eeb5cecc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "8f9f12f7-3b7d-433d-91cf-154a1549f319",
      "EndDate": "2026-08-07T22:49:42.324174+00:00",
      "StartDate": "2026-08-07T22:49:42.324174+00:00",
      "SchedulePreferenceDate": "2026-08-07T22:49:42.324174+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": "7435d17d-79fc-4d0e-aab8-e74c9d1964de",
      "UserId": "064e1e99-7449-4c5e-8eb0-3dd4510ce1f7",
      "IsCurrent": true,
      "CenterId": "4281bfc3-92de-4402-a5ed-74e2eeb5cecc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "8f9f12f7-3b7d-433d-91cf-154a1549f319",
      "EndDate": "2026-08-07T22:49:42.324174+00:00",
      "StartDate": "2026-08-07T22:49:42.324174+00:00",
      "SchedulePreferenceDate": "2026-08-07T22:49:42.324174+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-08-07T22:49:42.324174+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "059b4ac6-2d0f-4cba-9d58-0a5fc899793c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "61a1fd61-cd51-45f6-a153-0265c0b81852",
      "Sequence": 1,
      "AncestorCategoryId": "dd16e60c-65d9-435d-841e-7b8a0c7c4a69",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "059b4ac6-2d0f-4cba-9d58-0a5fc899793c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "61a1fd61-cd51-45f6-a153-0265c0b81852",
      "Sequence": 1,
      "AncestorCategoryId": "dd16e60c-65d9-435d-841e-7b8a0c7c4a69",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "d15ef0ac-1a31-4a5e-b94b-0e8320c546ff",
          "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": "06dca927-823e-483c-9a8b-b1d12165a8c4",
    "CategoryId": "402b3149-1bef-4781-89a6-0dd71e84ed32",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "dc4b6bfd-b8e6-4ac3-8296-158c71ac93c6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "dc4b6bfd-b8e6-4ac3-8296-158c71ac93c6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "77f18d14-7b9c-458e-ad9f-757ff32a9e9e",
      "Questions": [
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "77f18d14-7b9c-458e-ad9f-757ff32a9e9e",
      "Questions": [
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9f0d95d4-4317-4d3e-92bc-48b4d8fd39f0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7e3062f0-15ae-44c5-8d99-43681d6fbe59",
      "ContentItemId": "677d8d2d-d33a-4632-b8ec-85ae7e4427c2",
      "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-08-07T22:49:42.324174+00:00",
      "RescheduleDate": "2026-08-07T22:49:42.324174+00:00"
    },
    {
      "Id": "7e3062f0-15ae-44c5-8d99-43681d6fbe59",
      "ContentItemId": "677d8d2d-d33a-4632-b8ec-85ae7e4427c2",
      "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-08-07T22:49:42.324174+00:00",
      "RescheduleDate": "2026-08-07T22:49:42.324174+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}