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": "8477602b-764e-4731-bfc5-6311212e982d",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-23T15:25:52.0026147+00:00",
  "Registration": [
    {
      "Id": "c4ef12f0-8487-4fd9-92ab-a76e1034f69b",
      "UserId": "9e56a6ee-6f43-46f0-a5bb-99ce6f267add",
      "IsCurrent": true,
      "CenterId": "dd232416-58e7-46b7-9c59-d2b21711ae4a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "509210a3-6708-493b-aea8-0bd6955afb39",
      "EndDate": "2026-03-23T15:25:51.9869897+00:00",
      "StartDate": "2026-03-23T15:25:51.9869897+00:00",
      "SchedulePreferenceDate": "2026-03-23T15:25:51.9869897+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": "c4ef12f0-8487-4fd9-92ab-a76e1034f69b",
      "UserId": "9e56a6ee-6f43-46f0-a5bb-99ce6f267add",
      "IsCurrent": true,
      "CenterId": "dd232416-58e7-46b7-9c59-d2b21711ae4a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "509210a3-6708-493b-aea8-0bd6955afb39",
      "EndDate": "2026-03-23T15:25:51.9869897+00:00",
      "StartDate": "2026-03-23T15:25:51.9869897+00:00",
      "SchedulePreferenceDate": "2026-03-23T15:25:51.9869897+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-03-23T15:25:51.9869897+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "80afbaee-612f-4af5-bcd6-c99f5eadcc3e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "57a80ba4-dfb1-4bb9-bcd3-bd5c9429d4bd",
      "Sequence": 1,
      "AncestorCategoryId": "230281b1-287a-4e06-919e-735fdb42d2f8",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "80afbaee-612f-4af5-bcd6-c99f5eadcc3e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "57a80ba4-dfb1-4bb9-bcd3-bd5c9429d4bd",
      "Sequence": 1,
      "AncestorCategoryId": "230281b1-287a-4e06-919e-735fdb42d2f8",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "fac0c102-37e2-4af4-a64a-fdfaf2d67ff9",
    "CategoryId": "e3b0e517-8582-4337-8dd6-1a0e7aed6124",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "818b2ab9-5e0e-4c3b-aebb-219c13eef969",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "818b2ab9-5e0e-4c3b-aebb-219c13eef969",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "da4006b3-4d0c-40a6-b319-8c93153aebd7",
      "Questions": [
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        },
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "da4006b3-4d0c-40a6-b319-8c93153aebd7",
      "Questions": [
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        },
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0fef7fed-0c12-4f8b-a30b-722c11f55f7d",
      "ContentItemId": "80b6fe17-c123-4b61-be18-9cf5ed9befee",
      "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-03-23T15:25:51.9869897+00:00",
      "RescheduleDate": "2026-03-23T15:25:51.9869897+00:00"
    },
    {
      "Id": "0fef7fed-0c12-4f8b-a30b-722c11f55f7d",
      "ContentItemId": "80b6fe17-c123-4b61-be18-9cf5ed9befee",
      "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-03-23T15:25:51.9869897+00:00",
      "RescheduleDate": "2026-03-23T15:25:51.9869897+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": "8477602b-764e-4731-bfc5-6311212e982d",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-23T15:25:52.0338649+00:00",
  "Registration": [
    {
      "Id": "c4ef12f0-8487-4fd9-92ab-a76e1034f69b",
      "UserId": "9e56a6ee-6f43-46f0-a5bb-99ce6f267add",
      "IsCurrent": true,
      "CenterId": "dd232416-58e7-46b7-9c59-d2b21711ae4a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "509210a3-6708-493b-aea8-0bd6955afb39",
      "EndDate": "2026-03-23T15:25:51.9869897+00:00",
      "StartDate": "2026-03-23T15:25:51.9869897+00:00",
      "SchedulePreferenceDate": "2026-03-23T15:25:51.9869897+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": "c4ef12f0-8487-4fd9-92ab-a76e1034f69b",
      "UserId": "9e56a6ee-6f43-46f0-a5bb-99ce6f267add",
      "IsCurrent": true,
      "CenterId": "dd232416-58e7-46b7-9c59-d2b21711ae4a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "509210a3-6708-493b-aea8-0bd6955afb39",
      "EndDate": "2026-03-23T15:25:51.9869897+00:00",
      "StartDate": "2026-03-23T15:25:51.9869897+00:00",
      "SchedulePreferenceDate": "2026-03-23T15:25:51.9869897+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-03-23T15:25:51.9869897+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "80afbaee-612f-4af5-bcd6-c99f5eadcc3e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "57a80ba4-dfb1-4bb9-bcd3-bd5c9429d4bd",
      "Sequence": 1,
      "AncestorCategoryId": "230281b1-287a-4e06-919e-735fdb42d2f8",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "80afbaee-612f-4af5-bcd6-c99f5eadcc3e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "57a80ba4-dfb1-4bb9-bcd3-bd5c9429d4bd",
      "Sequence": 1,
      "AncestorCategoryId": "230281b1-287a-4e06-919e-735fdb42d2f8",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "22e90980-99e9-47c5-bf3e-3e45161961ae",
          "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": "fac0c102-37e2-4af4-a64a-fdfaf2d67ff9",
    "CategoryId": "e3b0e517-8582-4337-8dd6-1a0e7aed6124",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "818b2ab9-5e0e-4c3b-aebb-219c13eef969",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "818b2ab9-5e0e-4c3b-aebb-219c13eef969",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "da4006b3-4d0c-40a6-b319-8c93153aebd7",
      "Questions": [
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        },
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "da4006b3-4d0c-40a6-b319-8c93153aebd7",
      "Questions": [
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        },
        {
          "Id": "1a2d6b3c-5584-49dd-9bbc-bb602367acec",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0fef7fed-0c12-4f8b-a30b-722c11f55f7d",
      "ContentItemId": "80b6fe17-c123-4b61-be18-9cf5ed9befee",
      "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-03-23T15:25:51.9869897+00:00",
      "RescheduleDate": "2026-03-23T15:25:51.9869897+00:00"
    },
    {
      "Id": "0fef7fed-0c12-4f8b-a30b-722c11f55f7d",
      "ContentItemId": "80b6fe17-c123-4b61-be18-9cf5ed9befee",
      "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-03-23T15:25:51.9869897+00:00",
      "RescheduleDate": "2026-03-23T15:25:51.9869897+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}