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": "0c42fcfc-88d2-4315-849d-dc0afe6256e3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-17T17:30:20.8594936+00:00",
  "Registration": [
    {
      "Id": "a84b8210-6c89-4944-8969-e85001cd9718",
      "UserId": "17850ed4-2789-4241-94f1-de06e657c932",
      "IsCurrent": true,
      "CenterId": "1850f401-966a-4713-8f57-af84a34ec8a4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "42e17b55-f8a2-46d6-9d5a-54d152e71b52",
      "EndDate": "2026-06-17T17:30:20.8594936+00:00",
      "StartDate": "2026-06-17T17:30:20.8594936+00:00",
      "SchedulePreferenceDate": "2026-06-17T17:30:20.8594936+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": "a84b8210-6c89-4944-8969-e85001cd9718",
      "UserId": "17850ed4-2789-4241-94f1-de06e657c932",
      "IsCurrent": true,
      "CenterId": "1850f401-966a-4713-8f57-af84a34ec8a4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "42e17b55-f8a2-46d6-9d5a-54d152e71b52",
      "EndDate": "2026-06-17T17:30:20.8594936+00:00",
      "StartDate": "2026-06-17T17:30:20.8594936+00:00",
      "SchedulePreferenceDate": "2026-06-17T17:30:20.8594936+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-17T17:30:20.8594936+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9eceedd7-d40e-4352-90f0-9f3e5af34a92",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c11cb7f3-f000-426a-b668-a683a5caabc0",
      "Sequence": 1,
      "AncestorCategoryId": "d8bbb3e4-3958-43bd-a281-861b885deefc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "9eceedd7-d40e-4352-90f0-9f3e5af34a92",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c11cb7f3-f000-426a-b668-a683a5caabc0",
      "Sequence": 1,
      "AncestorCategoryId": "d8bbb3e4-3958-43bd-a281-861b885deefc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "70a5e6b9-3dfa-4ae4-900a-17f4a49b534c",
    "CategoryId": "67ad891a-e2e3-4bc3-a2c8-b322eb25533b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "269cd3b3-7a94-4bfd-a107-d00fd39d1616",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "269cd3b3-7a94-4bfd-a107-d00fd39d1616",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "5264db7f-908b-4e46-9773-ab1f6f844ceb",
      "Questions": [
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "5264db7f-908b-4e46-9773-ab1f6f844ceb",
      "Questions": [
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8ed14463-a99f-4553-ba98-3b0988e68c80",
      "ContentItemId": "f7e92e7d-3d2d-4ea2-9555-16df0109d391",
      "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-17T17:30:20.8594936+00:00",
      "RescheduleDate": "2026-06-17T17:30:20.8594936+00:00"
    },
    {
      "Id": "8ed14463-a99f-4553-ba98-3b0988e68c80",
      "ContentItemId": "f7e92e7d-3d2d-4ea2-9555-16df0109d391",
      "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-17T17:30:20.8594936+00:00",
      "RescheduleDate": "2026-06-17T17:30:20.8594936+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": "0c42fcfc-88d2-4315-849d-dc0afe6256e3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-17T17:30:20.9219913+00:00",
  "Registration": [
    {
      "Id": "a84b8210-6c89-4944-8969-e85001cd9718",
      "UserId": "17850ed4-2789-4241-94f1-de06e657c932",
      "IsCurrent": true,
      "CenterId": "1850f401-966a-4713-8f57-af84a34ec8a4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "42e17b55-f8a2-46d6-9d5a-54d152e71b52",
      "EndDate": "2026-06-17T17:30:20.8594936+00:00",
      "StartDate": "2026-06-17T17:30:20.8594936+00:00",
      "SchedulePreferenceDate": "2026-06-17T17:30:20.8594936+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": "a84b8210-6c89-4944-8969-e85001cd9718",
      "UserId": "17850ed4-2789-4241-94f1-de06e657c932",
      "IsCurrent": true,
      "CenterId": "1850f401-966a-4713-8f57-af84a34ec8a4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "42e17b55-f8a2-46d6-9d5a-54d152e71b52",
      "EndDate": "2026-06-17T17:30:20.8594936+00:00",
      "StartDate": "2026-06-17T17:30:20.8594936+00:00",
      "SchedulePreferenceDate": "2026-06-17T17:30:20.8594936+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-17T17:30:20.8594936+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9eceedd7-d40e-4352-90f0-9f3e5af34a92",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c11cb7f3-f000-426a-b668-a683a5caabc0",
      "Sequence": 1,
      "AncestorCategoryId": "d8bbb3e4-3958-43bd-a281-861b885deefc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "9eceedd7-d40e-4352-90f0-9f3e5af34a92",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c11cb7f3-f000-426a-b668-a683a5caabc0",
      "Sequence": 1,
      "AncestorCategoryId": "d8bbb3e4-3958-43bd-a281-861b885deefc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "0d90c21c-0586-4b6e-8a0a-3dff99259138",
          "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": "70a5e6b9-3dfa-4ae4-900a-17f4a49b534c",
    "CategoryId": "67ad891a-e2e3-4bc3-a2c8-b322eb25533b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "269cd3b3-7a94-4bfd-a107-d00fd39d1616",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "269cd3b3-7a94-4bfd-a107-d00fd39d1616",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "5264db7f-908b-4e46-9773-ab1f6f844ceb",
      "Questions": [
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "5264db7f-908b-4e46-9773-ab1f6f844ceb",
      "Questions": [
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c8e0770-4869-4bf1-89ec-2dd7f6436d67",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8ed14463-a99f-4553-ba98-3b0988e68c80",
      "ContentItemId": "f7e92e7d-3d2d-4ea2-9555-16df0109d391",
      "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-17T17:30:20.8594936+00:00",
      "RescheduleDate": "2026-06-17T17:30:20.8594936+00:00"
    },
    {
      "Id": "8ed14463-a99f-4553-ba98-3b0988e68c80",
      "ContentItemId": "f7e92e7d-3d2d-4ea2-9555-16df0109d391",
      "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-17T17:30:20.8594936+00:00",
      "RescheduleDate": "2026-06-17T17:30:20.8594936+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}