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": "41a735e5-e7b0-4ff5-9429-1cf57b2cb8e3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-29T10:30:23.8444385+00:00",
  "Registration": [
    {
      "Id": "5b3b0deb-6323-4015-8042-225aac1a1208",
      "UserId": "fcb0c4de-0f41-47c8-9f63-b928cad86c70",
      "IsCurrent": true,
      "CenterId": "8dd9ef1e-59ff-4826-b13e-a870e5e4c2f4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3a3838c2-3ac1-4f08-8a03-760dba1aab55",
      "EndDate": "2026-06-29T10:30:23.8288121+00:00",
      "StartDate": "2026-06-29T10:30:23.8288121+00:00",
      "SchedulePreferenceDate": "2026-06-29T10:30:23.8288121+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": "5b3b0deb-6323-4015-8042-225aac1a1208",
      "UserId": "fcb0c4de-0f41-47c8-9f63-b928cad86c70",
      "IsCurrent": true,
      "CenterId": "8dd9ef1e-59ff-4826-b13e-a870e5e4c2f4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3a3838c2-3ac1-4f08-8a03-760dba1aab55",
      "EndDate": "2026-06-29T10:30:23.8288121+00:00",
      "StartDate": "2026-06-29T10:30:23.8288121+00:00",
      "SchedulePreferenceDate": "2026-06-29T10:30:23.8288121+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-06-29T10:30:23.8288121+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6870e91f-3bcc-439a-b3b0-d1b8078f790a",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c6f8b601-0d6a-4bc4-ae00-93c613cae4d6",
      "Sequence": 1,
      "AncestorCategoryId": "acc58818-532d-4307-9399-7a11c28fd841",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "6870e91f-3bcc-439a-b3b0-d1b8078f790a",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c6f8b601-0d6a-4bc4-ae00-93c613cae4d6",
      "Sequence": 1,
      "AncestorCategoryId": "acc58818-532d-4307-9399-7a11c28fd841",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "7f47a6ff-72f8-4e7b-926a-e1fba21acc53",
    "CategoryId": "5f5c8805-3077-47ce-ab8d-3c7a1f3d8223",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0dd79039-68db-4aa2-b7b9-d2c1dd819c3c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0dd79039-68db-4aa2-b7b9-d2c1dd819c3c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "6166c992-a8c8-40e4-8cfa-e019e81408cb",
      "Questions": [
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        },
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "6166c992-a8c8-40e4-8cfa-e019e81408cb",
      "Questions": [
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        },
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "614ba182-7d19-4db5-8d21-a62478a95a3a",
      "ContentItemId": "bcf2c4dd-1ee1-4d28-82a1-29c572b60b89",
      "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-06-29T10:30:23.8288121+00:00",
      "RescheduleDate": "2026-06-29T10:30:23.8288121+00:00"
    },
    {
      "Id": "614ba182-7d19-4db5-8d21-a62478a95a3a",
      "ContentItemId": "bcf2c4dd-1ee1-4d28-82a1-29c572b60b89",
      "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-06-29T10:30:23.8288121+00:00",
      "RescheduleDate": "2026-06-29T10:30:23.8288121+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": "41a735e5-e7b0-4ff5-9429-1cf57b2cb8e3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-29T10:30:23.8756916+00:00",
  "Registration": [
    {
      "Id": "5b3b0deb-6323-4015-8042-225aac1a1208",
      "UserId": "fcb0c4de-0f41-47c8-9f63-b928cad86c70",
      "IsCurrent": true,
      "CenterId": "8dd9ef1e-59ff-4826-b13e-a870e5e4c2f4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3a3838c2-3ac1-4f08-8a03-760dba1aab55",
      "EndDate": "2026-06-29T10:30:23.8288121+00:00",
      "StartDate": "2026-06-29T10:30:23.8288121+00:00",
      "SchedulePreferenceDate": "2026-06-29T10:30:23.8288121+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": "5b3b0deb-6323-4015-8042-225aac1a1208",
      "UserId": "fcb0c4de-0f41-47c8-9f63-b928cad86c70",
      "IsCurrent": true,
      "CenterId": "8dd9ef1e-59ff-4826-b13e-a870e5e4c2f4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3a3838c2-3ac1-4f08-8a03-760dba1aab55",
      "EndDate": "2026-06-29T10:30:23.8288121+00:00",
      "StartDate": "2026-06-29T10:30:23.8288121+00:00",
      "SchedulePreferenceDate": "2026-06-29T10:30:23.8288121+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-06-29T10:30:23.8288121+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6870e91f-3bcc-439a-b3b0-d1b8078f790a",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c6f8b601-0d6a-4bc4-ae00-93c613cae4d6",
      "Sequence": 1,
      "AncestorCategoryId": "acc58818-532d-4307-9399-7a11c28fd841",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "6870e91f-3bcc-439a-b3b0-d1b8078f790a",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c6f8b601-0d6a-4bc4-ae00-93c613cae4d6",
      "Sequence": 1,
      "AncestorCategoryId": "acc58818-532d-4307-9399-7a11c28fd841",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "48320201-e1a5-4b67-9007-6e601a94ead7",
          "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": "7f47a6ff-72f8-4e7b-926a-e1fba21acc53",
    "CategoryId": "5f5c8805-3077-47ce-ab8d-3c7a1f3d8223",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0dd79039-68db-4aa2-b7b9-d2c1dd819c3c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0dd79039-68db-4aa2-b7b9-d2c1dd819c3c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "6166c992-a8c8-40e4-8cfa-e019e81408cb",
      "Questions": [
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        },
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "6166c992-a8c8-40e4-8cfa-e019e81408cb",
      "Questions": [
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        },
        {
          "Id": "3f907a50-4ac2-418c-a549-1a16dd438c15",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "614ba182-7d19-4db5-8d21-a62478a95a3a",
      "ContentItemId": "bcf2c4dd-1ee1-4d28-82a1-29c572b60b89",
      "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-06-29T10:30:23.8288121+00:00",
      "RescheduleDate": "2026-06-29T10:30:23.8288121+00:00"
    },
    {
      "Id": "614ba182-7d19-4db5-8d21-a62478a95a3a",
      "ContentItemId": "bcf2c4dd-1ee1-4d28-82a1-29c572b60b89",
      "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-06-29T10:30:23.8288121+00:00",
      "RescheduleDate": "2026-06-29T10:30:23.8288121+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}