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": "42524e18-1a8f-448a-a0ed-dde71f049bd4",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-19T20:58:51.5779459+00:00",
  "Registration": [
    {
      "Id": "dcad7708-33a6-4add-a996-24d2c3b94141",
      "UserId": "fc23bd0b-821b-49f7-835d-f4fd084921e7",
      "IsCurrent": true,
      "CenterId": "7c6fe3a2-e526-4747-ad79-65d94f152225",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "17c693a7-4151-4cfe-aff8-7dce32bb805c",
      "EndDate": "2026-06-19T20:58:51.5779459+00:00",
      "StartDate": "2026-06-19T20:58:51.5779459+00:00",
      "SchedulePreferenceDate": "2026-06-19T20:58:51.5779459+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": "dcad7708-33a6-4add-a996-24d2c3b94141",
      "UserId": "fc23bd0b-821b-49f7-835d-f4fd084921e7",
      "IsCurrent": true,
      "CenterId": "7c6fe3a2-e526-4747-ad79-65d94f152225",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "17c693a7-4151-4cfe-aff8-7dce32bb805c",
      "EndDate": "2026-06-19T20:58:51.5779459+00:00",
      "StartDate": "2026-06-19T20:58:51.5779459+00:00",
      "SchedulePreferenceDate": "2026-06-19T20:58:51.5779459+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-19T20:58:51.5779459+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "ee511c9b-6c0a-4aa3-a15f-907c4310ac49",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "950694dd-93ca-42f8-885d-926dfde14431",
      "Sequence": 1,
      "AncestorCategoryId": "a49e7f75-5ef3-46c9-99c7-66a823c5a470",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "ee511c9b-6c0a-4aa3-a15f-907c4310ac49",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "950694dd-93ca-42f8-885d-926dfde14431",
      "Sequence": 1,
      "AncestorCategoryId": "a49e7f75-5ef3-46c9-99c7-66a823c5a470",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "403569e3-5172-4a82-91b2-30aaa3cd12f3",
    "CategoryId": "113766f4-b89d-4e59-a607-10a0422b2bd7",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6a3c92ee-1547-41f3-a917-5972f43da6a0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6a3c92ee-1547-41f3-a917-5972f43da6a0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "16845a4b-6e66-4aac-bfa0-abac0586b357",
      "Questions": [
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        },
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "16845a4b-6e66-4aac-bfa0-abac0586b357",
      "Questions": [
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        },
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "448c9bf7-fb9a-4ea1-89d1-c8ec27fe32ad",
      "ContentItemId": "a0aa81f5-6c5d-4541-bbcb-465437aca0b9",
      "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-19T20:58:51.5779459+00:00",
      "RescheduleDate": "2026-06-19T20:58:51.5779459+00:00"
    },
    {
      "Id": "448c9bf7-fb9a-4ea1-89d1-c8ec27fe32ad",
      "ContentItemId": "a0aa81f5-6c5d-4541-bbcb-465437aca0b9",
      "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-19T20:58:51.5779459+00:00",
      "RescheduleDate": "2026-06-19T20:58:51.5779459+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": "42524e18-1a8f-448a-a0ed-dde71f049bd4",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-19T20:58:51.6092028+00:00",
  "Registration": [
    {
      "Id": "dcad7708-33a6-4add-a996-24d2c3b94141",
      "UserId": "fc23bd0b-821b-49f7-835d-f4fd084921e7",
      "IsCurrent": true,
      "CenterId": "7c6fe3a2-e526-4747-ad79-65d94f152225",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "17c693a7-4151-4cfe-aff8-7dce32bb805c",
      "EndDate": "2026-06-19T20:58:51.5779459+00:00",
      "StartDate": "2026-06-19T20:58:51.5779459+00:00",
      "SchedulePreferenceDate": "2026-06-19T20:58:51.5779459+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": "dcad7708-33a6-4add-a996-24d2c3b94141",
      "UserId": "fc23bd0b-821b-49f7-835d-f4fd084921e7",
      "IsCurrent": true,
      "CenterId": "7c6fe3a2-e526-4747-ad79-65d94f152225",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "17c693a7-4151-4cfe-aff8-7dce32bb805c",
      "EndDate": "2026-06-19T20:58:51.5779459+00:00",
      "StartDate": "2026-06-19T20:58:51.5779459+00:00",
      "SchedulePreferenceDate": "2026-06-19T20:58:51.5779459+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-19T20:58:51.5779459+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "ee511c9b-6c0a-4aa3-a15f-907c4310ac49",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "950694dd-93ca-42f8-885d-926dfde14431",
      "Sequence": 1,
      "AncestorCategoryId": "a49e7f75-5ef3-46c9-99c7-66a823c5a470",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "ee511c9b-6c0a-4aa3-a15f-907c4310ac49",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "950694dd-93ca-42f8-885d-926dfde14431",
      "Sequence": 1,
      "AncestorCategoryId": "a49e7f75-5ef3-46c9-99c7-66a823c5a470",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "7739fc2c-15bb-4947-92c7-f7ed523d107f",
          "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": "403569e3-5172-4a82-91b2-30aaa3cd12f3",
    "CategoryId": "113766f4-b89d-4e59-a607-10a0422b2bd7",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6a3c92ee-1547-41f3-a917-5972f43da6a0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6a3c92ee-1547-41f3-a917-5972f43da6a0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "16845a4b-6e66-4aac-bfa0-abac0586b357",
      "Questions": [
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        },
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "16845a4b-6e66-4aac-bfa0-abac0586b357",
      "Questions": [
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        },
        {
          "Id": "f62482b1-1325-4ba1-935b-d972a95d5bc8",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "448c9bf7-fb9a-4ea1-89d1-c8ec27fe32ad",
      "ContentItemId": "a0aa81f5-6c5d-4541-bbcb-465437aca0b9",
      "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-19T20:58:51.5779459+00:00",
      "RescheduleDate": "2026-06-19T20:58:51.5779459+00:00"
    },
    {
      "Id": "448c9bf7-fb9a-4ea1-89d1-c8ec27fe32ad",
      "ContentItemId": "a0aa81f5-6c5d-4541-bbcb-465437aca0b9",
      "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-19T20:58:51.5779459+00:00",
      "RescheduleDate": "2026-06-19T20:58:51.5779459+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}