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": "c7d5dbd3-4b5f-4f08-a719-8421d25d578a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-05T12:41:52.6400911+00:00",
  "Registration": [
    {
      "Id": "4c83ff77-ba34-4e5e-a31b-d4703cd8fbc4",
      "UserId": "a6d008ad-d301-4ff7-a5b1-9ad3683254f6",
      "IsCurrent": true,
      "CenterId": "31f1b8fb-b356-410b-a65f-422c7d256ffb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "60e5fb55-c7f6-4346-bae2-6b25877937a6",
      "EndDate": "2026-02-05T12:41:52.6244631+00:00",
      "StartDate": "2026-02-05T12:41:52.6244631+00:00",
      "SchedulePreferenceDate": "2026-02-05T12:41:52.6244631+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": "4c83ff77-ba34-4e5e-a31b-d4703cd8fbc4",
      "UserId": "a6d008ad-d301-4ff7-a5b1-9ad3683254f6",
      "IsCurrent": true,
      "CenterId": "31f1b8fb-b356-410b-a65f-422c7d256ffb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "60e5fb55-c7f6-4346-bae2-6b25877937a6",
      "EndDate": "2026-02-05T12:41:52.6244631+00:00",
      "StartDate": "2026-02-05T12:41:52.6244631+00:00",
      "SchedulePreferenceDate": "2026-02-05T12:41:52.6244631+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-02-05T12:41:52.6244631+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "5d025ed5-a776-45c8-ad92-dcee1eae9b65",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1f683f13-b4c4-41f4-a4c7-b4e9a6eade31",
      "Sequence": 1,
      "AncestorCategoryId": "6e3b2cb6-1c39-479d-a0d8-9ebedf06c7ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "5d025ed5-a776-45c8-ad92-dcee1eae9b65",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1f683f13-b4c4-41f4-a4c7-b4e9a6eade31",
      "Sequence": 1,
      "AncestorCategoryId": "6e3b2cb6-1c39-479d-a0d8-9ebedf06c7ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "4f8010c4-fcbe-46e4-bba9-3e71ddd56f7a",
    "CategoryId": "a1410276-b4f1-4170-90a5-db8ddf91a422",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "8cd1812f-07ec-4fbb-bc6b-b92d0a3c1c12",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "8cd1812f-07ec-4fbb-bc6b-b92d0a3c1c12",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "94dd1176-26a1-4c2d-9dae-2da56ad79483",
      "Questions": [
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "94dd1176-26a1-4c2d-9dae-2da56ad79483",
      "Questions": [
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "be7342cb-5c7a-4968-8ff1-99a063fd1bed",
      "ContentItemId": "80e5555c-5bec-4087-a27f-1bb1f1f03c4d",
      "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-02-05T12:41:52.6244631+00:00",
      "RescheduleDate": "2026-02-05T12:41:52.6244631+00:00"
    },
    {
      "Id": "be7342cb-5c7a-4968-8ff1-99a063fd1bed",
      "ContentItemId": "80e5555c-5bec-4087-a27f-1bb1f1f03c4d",
      "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-02-05T12:41:52.6244631+00:00",
      "RescheduleDate": "2026-02-05T12:41:52.6244631+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": "c7d5dbd3-4b5f-4f08-a719-8421d25d578a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-05T12:41:52.6869664+00:00",
  "Registration": [
    {
      "Id": "4c83ff77-ba34-4e5e-a31b-d4703cd8fbc4",
      "UserId": "a6d008ad-d301-4ff7-a5b1-9ad3683254f6",
      "IsCurrent": true,
      "CenterId": "31f1b8fb-b356-410b-a65f-422c7d256ffb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "60e5fb55-c7f6-4346-bae2-6b25877937a6",
      "EndDate": "2026-02-05T12:41:52.6244631+00:00",
      "StartDate": "2026-02-05T12:41:52.6244631+00:00",
      "SchedulePreferenceDate": "2026-02-05T12:41:52.6244631+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": "4c83ff77-ba34-4e5e-a31b-d4703cd8fbc4",
      "UserId": "a6d008ad-d301-4ff7-a5b1-9ad3683254f6",
      "IsCurrent": true,
      "CenterId": "31f1b8fb-b356-410b-a65f-422c7d256ffb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "60e5fb55-c7f6-4346-bae2-6b25877937a6",
      "EndDate": "2026-02-05T12:41:52.6244631+00:00",
      "StartDate": "2026-02-05T12:41:52.6244631+00:00",
      "SchedulePreferenceDate": "2026-02-05T12:41:52.6244631+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-02-05T12:41:52.6244631+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "5d025ed5-a776-45c8-ad92-dcee1eae9b65",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1f683f13-b4c4-41f4-a4c7-b4e9a6eade31",
      "Sequence": 1,
      "AncestorCategoryId": "6e3b2cb6-1c39-479d-a0d8-9ebedf06c7ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "5d025ed5-a776-45c8-ad92-dcee1eae9b65",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1f683f13-b4c4-41f4-a4c7-b4e9a6eade31",
      "Sequence": 1,
      "AncestorCategoryId": "6e3b2cb6-1c39-479d-a0d8-9ebedf06c7ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "b42d12ff-5c89-46e9-95c3-d5e23fd841ad",
          "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": "4f8010c4-fcbe-46e4-bba9-3e71ddd56f7a",
    "CategoryId": "a1410276-b4f1-4170-90a5-db8ddf91a422",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "8cd1812f-07ec-4fbb-bc6b-b92d0a3c1c12",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "8cd1812f-07ec-4fbb-bc6b-b92d0a3c1c12",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "94dd1176-26a1-4c2d-9dae-2da56ad79483",
      "Questions": [
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "94dd1176-26a1-4c2d-9dae-2da56ad79483",
      "Questions": [
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "54a19008-1329-4524-9b5b-99d49418b6a1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "be7342cb-5c7a-4968-8ff1-99a063fd1bed",
      "ContentItemId": "80e5555c-5bec-4087-a27f-1bb1f1f03c4d",
      "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-02-05T12:41:52.6244631+00:00",
      "RescheduleDate": "2026-02-05T12:41:52.6244631+00:00"
    },
    {
      "Id": "be7342cb-5c7a-4968-8ff1-99a063fd1bed",
      "ContentItemId": "80e5555c-5bec-4087-a27f-1bb1f1f03c4d",
      "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-02-05T12:41:52.6244631+00:00",
      "RescheduleDate": "2026-02-05T12:41:52.6244631+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}