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": "b3d6b850-10f0-493a-964e-6ba4d55eb7c6",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-14T08:33:02.8113649+00:00",
  "Registration": [
    {
      "Id": "91d52407-1f6b-401d-a6f5-f5a4da25a88d",
      "UserId": "e6fdf3cb-2cf2-42b6-951d-0ea5c0c29746",
      "IsCurrent": true,
      "CenterId": "aa4b9360-6be7-4c94-9bd2-b44844f4ea41",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b5dccc3c-eea1-48de-a461-3e41e592fa55",
      "EndDate": "2026-11-14T08:33:02.8113649+00:00",
      "StartDate": "2026-11-14T08:33:02.8113649+00:00",
      "SchedulePreferenceDate": "2026-11-14T08:33:02.8113649+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": "91d52407-1f6b-401d-a6f5-f5a4da25a88d",
      "UserId": "e6fdf3cb-2cf2-42b6-951d-0ea5c0c29746",
      "IsCurrent": true,
      "CenterId": "aa4b9360-6be7-4c94-9bd2-b44844f4ea41",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b5dccc3c-eea1-48de-a461-3e41e592fa55",
      "EndDate": "2026-11-14T08:33:02.8113649+00:00",
      "StartDate": "2026-11-14T08:33:02.8113649+00:00",
      "SchedulePreferenceDate": "2026-11-14T08:33:02.8113649+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-11-14T08:33:02.8113649+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "dea77570-0a9b-485a-be42-127222650fdf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3997d30f-7b3b-4b89-9495-63e4dc0ffe39",
      "Sequence": 1,
      "AncestorCategoryId": "f716124e-2046-45e7-b22d-bf1178621da5",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "dea77570-0a9b-485a-be42-127222650fdf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3997d30f-7b3b-4b89-9495-63e4dc0ffe39",
      "Sequence": 1,
      "AncestorCategoryId": "f716124e-2046-45e7-b22d-bf1178621da5",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "84b583db-cdbf-4e45-8ab4-c6eaca7f49a3",
    "CategoryId": "565235b2-6651-4a46-8927-dbce2e6780aa",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2eb6d771-428a-41ba-b89e-4e1a66de4ca4",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2eb6d771-428a-41ba-b89e-4e1a66de4ca4",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "28fb0c60-e2d4-43c8-8549-ae6c1d0d49d0",
      "Questions": [
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        },
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "28fb0c60-e2d4-43c8-8549-ae6c1d0d49d0",
      "Questions": [
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        },
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "b2d86720-930f-413c-92c2-a8089a294ad7",
      "ContentItemId": "b68c4e36-70d4-42bf-a123-59efbb037bbd",
      "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-11-14T08:33:02.8113649+00:00",
      "RescheduleDate": "2026-11-14T08:33:02.8113649+00:00"
    },
    {
      "Id": "b2d86720-930f-413c-92c2-a8089a294ad7",
      "ContentItemId": "b68c4e36-70d4-42bf-a123-59efbb037bbd",
      "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-11-14T08:33:02.8113649+00:00",
      "RescheduleDate": "2026-11-14T08:33:02.8113649+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": "b3d6b850-10f0-493a-964e-6ba4d55eb7c6",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-14T08:33:02.8582425+00:00",
  "Registration": [
    {
      "Id": "91d52407-1f6b-401d-a6f5-f5a4da25a88d",
      "UserId": "e6fdf3cb-2cf2-42b6-951d-0ea5c0c29746",
      "IsCurrent": true,
      "CenterId": "aa4b9360-6be7-4c94-9bd2-b44844f4ea41",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b5dccc3c-eea1-48de-a461-3e41e592fa55",
      "EndDate": "2026-11-14T08:33:02.8113649+00:00",
      "StartDate": "2026-11-14T08:33:02.8113649+00:00",
      "SchedulePreferenceDate": "2026-11-14T08:33:02.8113649+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": "91d52407-1f6b-401d-a6f5-f5a4da25a88d",
      "UserId": "e6fdf3cb-2cf2-42b6-951d-0ea5c0c29746",
      "IsCurrent": true,
      "CenterId": "aa4b9360-6be7-4c94-9bd2-b44844f4ea41",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b5dccc3c-eea1-48de-a461-3e41e592fa55",
      "EndDate": "2026-11-14T08:33:02.8113649+00:00",
      "StartDate": "2026-11-14T08:33:02.8113649+00:00",
      "SchedulePreferenceDate": "2026-11-14T08:33:02.8113649+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-11-14T08:33:02.8113649+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "dea77570-0a9b-485a-be42-127222650fdf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3997d30f-7b3b-4b89-9495-63e4dc0ffe39",
      "Sequence": 1,
      "AncestorCategoryId": "f716124e-2046-45e7-b22d-bf1178621da5",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "dea77570-0a9b-485a-be42-127222650fdf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3997d30f-7b3b-4b89-9495-63e4dc0ffe39",
      "Sequence": 1,
      "AncestorCategoryId": "f716124e-2046-45e7-b22d-bf1178621da5",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "f5178e7b-d93a-4864-8aa1-968b30db50e0",
          "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": "84b583db-cdbf-4e45-8ab4-c6eaca7f49a3",
    "CategoryId": "565235b2-6651-4a46-8927-dbce2e6780aa",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2eb6d771-428a-41ba-b89e-4e1a66de4ca4",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2eb6d771-428a-41ba-b89e-4e1a66de4ca4",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "28fb0c60-e2d4-43c8-8549-ae6c1d0d49d0",
      "Questions": [
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        },
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "28fb0c60-e2d4-43c8-8549-ae6c1d0d49d0",
      "Questions": [
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        },
        {
          "Id": "7d1453d9-9b8e-4109-9a02-4b9a2497af59",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "b2d86720-930f-413c-92c2-a8089a294ad7",
      "ContentItemId": "b68c4e36-70d4-42bf-a123-59efbb037bbd",
      "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-11-14T08:33:02.8113649+00:00",
      "RescheduleDate": "2026-11-14T08:33:02.8113649+00:00"
    },
    {
      "Id": "b2d86720-930f-413c-92c2-a8089a294ad7",
      "ContentItemId": "b68c4e36-70d4-42bf-a123-59efbb037bbd",
      "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-11-14T08:33:02.8113649+00:00",
      "RescheduleDate": "2026-11-14T08:33:02.8113649+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}