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": "6ca5630d-23d3-4ceb-b86e-0783cce8e462",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-07T05:22:00.0393531+00:00",
  "Registration": [
    {
      "Id": "fd98819b-1be5-41e2-822f-757f8deafb82",
      "UserId": "fbc2c948-0478-4a22-a406-e1918ef58115",
      "IsCurrent": true,
      "CenterId": "92021292-2ba8-4f52-b387-c19266cefaf0",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1be81d3b-f158-4b33-bcd9-14a567edcecb",
      "EndDate": "2026-10-07T05:22:00.0393531+00:00",
      "StartDate": "2026-10-07T05:22:00.0393531+00:00",
      "SchedulePreferenceDate": "2026-10-07T05:22:00.0393531+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": "fd98819b-1be5-41e2-822f-757f8deafb82",
      "UserId": "fbc2c948-0478-4a22-a406-e1918ef58115",
      "IsCurrent": true,
      "CenterId": "92021292-2ba8-4f52-b387-c19266cefaf0",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1be81d3b-f158-4b33-bcd9-14a567edcecb",
      "EndDate": "2026-10-07T05:22:00.0393531+00:00",
      "StartDate": "2026-10-07T05:22:00.0393531+00:00",
      "SchedulePreferenceDate": "2026-10-07T05:22:00.0393531+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-07T05:22:00.0393531+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "fd7a0969-f159-49f7-8534-f02b8e9b16b4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "27af9883-26db-4f48-8e1c-79a1b4c8162e",
      "Sequence": 1,
      "AncestorCategoryId": "67485df4-1720-41ba-bb99-a92cfc586414",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "fd7a0969-f159-49f7-8534-f02b8e9b16b4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "27af9883-26db-4f48-8e1c-79a1b4c8162e",
      "Sequence": 1,
      "AncestorCategoryId": "67485df4-1720-41ba-bb99-a92cfc586414",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "b0a97709-3a74-4a2e-aeb5-f1f13b40ca89",
    "CategoryId": "c1457602-d58e-4870-8d86-e80d6338fb77",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "bcc27ebb-ade6-49e0-99af-446a72a7221b",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "bcc27ebb-ade6-49e0-99af-446a72a7221b",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e84c5568-0a77-4e97-8fa1-d0ecbb70fcdf",
      "Questions": [
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e84c5568-0a77-4e97-8fa1-d0ecbb70fcdf",
      "Questions": [
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "94c4815e-66cc-4244-834c-d81613ff7145",
      "ContentItemId": "69aaec34-4abd-428d-9f7d-16a5ce9e5e04",
      "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-07T05:22:00.0393531+00:00",
      "RescheduleDate": "2026-10-07T05:22:00.0393531+00:00"
    },
    {
      "Id": "94c4815e-66cc-4244-834c-d81613ff7145",
      "ContentItemId": "69aaec34-4abd-428d-9f7d-16a5ce9e5e04",
      "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-07T05:22:00.0393531+00:00",
      "RescheduleDate": "2026-10-07T05:22:00.0393531+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": "6ca5630d-23d3-4ceb-b86e-0783cce8e462",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-07T05:22:00.0706053+00:00",
  "Registration": [
    {
      "Id": "fd98819b-1be5-41e2-822f-757f8deafb82",
      "UserId": "fbc2c948-0478-4a22-a406-e1918ef58115",
      "IsCurrent": true,
      "CenterId": "92021292-2ba8-4f52-b387-c19266cefaf0",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1be81d3b-f158-4b33-bcd9-14a567edcecb",
      "EndDate": "2026-10-07T05:22:00.0393531+00:00",
      "StartDate": "2026-10-07T05:22:00.0393531+00:00",
      "SchedulePreferenceDate": "2026-10-07T05:22:00.0393531+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": "fd98819b-1be5-41e2-822f-757f8deafb82",
      "UserId": "fbc2c948-0478-4a22-a406-e1918ef58115",
      "IsCurrent": true,
      "CenterId": "92021292-2ba8-4f52-b387-c19266cefaf0",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1be81d3b-f158-4b33-bcd9-14a567edcecb",
      "EndDate": "2026-10-07T05:22:00.0393531+00:00",
      "StartDate": "2026-10-07T05:22:00.0393531+00:00",
      "SchedulePreferenceDate": "2026-10-07T05:22:00.0393531+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-07T05:22:00.0393531+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "fd7a0969-f159-49f7-8534-f02b8e9b16b4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "27af9883-26db-4f48-8e1c-79a1b4c8162e",
      "Sequence": 1,
      "AncestorCategoryId": "67485df4-1720-41ba-bb99-a92cfc586414",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "fd7a0969-f159-49f7-8534-f02b8e9b16b4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "27af9883-26db-4f48-8e1c-79a1b4c8162e",
      "Sequence": 1,
      "AncestorCategoryId": "67485df4-1720-41ba-bb99-a92cfc586414",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "d2aace31-0e34-4cfc-8f8d-0412a709a4da",
          "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": "b0a97709-3a74-4a2e-aeb5-f1f13b40ca89",
    "CategoryId": "c1457602-d58e-4870-8d86-e80d6338fb77",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "bcc27ebb-ade6-49e0-99af-446a72a7221b",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "bcc27ebb-ade6-49e0-99af-446a72a7221b",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e84c5568-0a77-4e97-8fa1-d0ecbb70fcdf",
      "Questions": [
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e84c5568-0a77-4e97-8fa1-d0ecbb70fcdf",
      "Questions": [
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8befa7a-70e2-4a36-b851-b663afd3f533",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "94c4815e-66cc-4244-834c-d81613ff7145",
      "ContentItemId": "69aaec34-4abd-428d-9f7d-16a5ce9e5e04",
      "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-07T05:22:00.0393531+00:00",
      "RescheduleDate": "2026-10-07T05:22:00.0393531+00:00"
    },
    {
      "Id": "94c4815e-66cc-4244-834c-d81613ff7145",
      "ContentItemId": "69aaec34-4abd-428d-9f7d-16a5ce9e5e04",
      "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-07T05:22:00.0393531+00:00",
      "RescheduleDate": "2026-10-07T05:22:00.0393531+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}