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": "8380e60b-ce5a-4797-ab12-fc611cb9b04f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-16T06:42:04.6959861+00:00",
  "Registration": [
    {
      "Id": "e56b67c8-abbe-4b5e-8635-9c396fc166e4",
      "UserId": "6d798d79-bd36-4559-aebf-b459c415ca2d",
      "IsCurrent": true,
      "CenterId": "17d52169-507f-4c65-ad9b-fcbbbddd724a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "fa4c9c3a-bcf4-45ce-850a-26a102cf0ccb",
      "EndDate": "2026-08-16T06:42:04.6803579+00:00",
      "StartDate": "2026-08-16T06:42:04.6803579+00:00",
      "SchedulePreferenceDate": "2026-08-16T06:42:04.6803579+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": "e56b67c8-abbe-4b5e-8635-9c396fc166e4",
      "UserId": "6d798d79-bd36-4559-aebf-b459c415ca2d",
      "IsCurrent": true,
      "CenterId": "17d52169-507f-4c65-ad9b-fcbbbddd724a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "fa4c9c3a-bcf4-45ce-850a-26a102cf0ccb",
      "EndDate": "2026-08-16T06:42:04.6803579+00:00",
      "StartDate": "2026-08-16T06:42:04.6803579+00:00",
      "SchedulePreferenceDate": "2026-08-16T06:42:04.6803579+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-08-16T06:42:04.6803579+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e0756cb9-7c30-4877-8b88-3ba9bec7a50d",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2f0c3c39-4556-4c67-996b-4b53e3d213f3",
      "Sequence": 1,
      "AncestorCategoryId": "066d76ef-c325-4698-b6c2-5eedf88ac358",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "27553578-1945-4b56-8591-449d77c48799",
          "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": "27553578-1945-4b56-8591-449d77c48799",
          "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": "e0756cb9-7c30-4877-8b88-3ba9bec7a50d",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2f0c3c39-4556-4c67-996b-4b53e3d213f3",
      "Sequence": 1,
      "AncestorCategoryId": "066d76ef-c325-4698-b6c2-5eedf88ac358",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "27553578-1945-4b56-8591-449d77c48799",
          "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": "27553578-1945-4b56-8591-449d77c48799",
          "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": "a1afb7ff-6e40-4056-a97f-ffe48996ae09",
    "CategoryId": "1a18397c-dba8-415d-afb3-cbce4ef263c8",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "29df4ee5-bb7a-4f54-bcf6-7388663f0f95",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "29df4ee5-bb7a-4f54-bcf6-7388663f0f95",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "6c41389b-10d8-4672-a290-684226bf7085",
      "Questions": [
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        },
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "6c41389b-10d8-4672-a290-684226bf7085",
      "Questions": [
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        },
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "004d4f69-eb29-4183-954b-dca621c029f7",
      "ContentItemId": "57eb4022-b604-4dbd-aa8a-e8fe86e42925",
      "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-08-16T06:42:04.6803579+00:00",
      "RescheduleDate": "2026-08-16T06:42:04.6803579+00:00"
    },
    {
      "Id": "004d4f69-eb29-4183-954b-dca621c029f7",
      "ContentItemId": "57eb4022-b604-4dbd-aa8a-e8fe86e42925",
      "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-08-16T06:42:04.6803579+00:00",
      "RescheduleDate": "2026-08-16T06:42:04.6803579+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": "8380e60b-ce5a-4797-ab12-fc611cb9b04f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-16T06:42:04.7272358+00:00",
  "Registration": [
    {
      "Id": "e56b67c8-abbe-4b5e-8635-9c396fc166e4",
      "UserId": "6d798d79-bd36-4559-aebf-b459c415ca2d",
      "IsCurrent": true,
      "CenterId": "17d52169-507f-4c65-ad9b-fcbbbddd724a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "fa4c9c3a-bcf4-45ce-850a-26a102cf0ccb",
      "EndDate": "2026-08-16T06:42:04.6803579+00:00",
      "StartDate": "2026-08-16T06:42:04.6803579+00:00",
      "SchedulePreferenceDate": "2026-08-16T06:42:04.6803579+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": "e56b67c8-abbe-4b5e-8635-9c396fc166e4",
      "UserId": "6d798d79-bd36-4559-aebf-b459c415ca2d",
      "IsCurrent": true,
      "CenterId": "17d52169-507f-4c65-ad9b-fcbbbddd724a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "fa4c9c3a-bcf4-45ce-850a-26a102cf0ccb",
      "EndDate": "2026-08-16T06:42:04.6803579+00:00",
      "StartDate": "2026-08-16T06:42:04.6803579+00:00",
      "SchedulePreferenceDate": "2026-08-16T06:42:04.6803579+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-08-16T06:42:04.6803579+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e0756cb9-7c30-4877-8b88-3ba9bec7a50d",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2f0c3c39-4556-4c67-996b-4b53e3d213f3",
      "Sequence": 1,
      "AncestorCategoryId": "066d76ef-c325-4698-b6c2-5eedf88ac358",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "27553578-1945-4b56-8591-449d77c48799",
          "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": "27553578-1945-4b56-8591-449d77c48799",
          "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": "e0756cb9-7c30-4877-8b88-3ba9bec7a50d",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2f0c3c39-4556-4c67-996b-4b53e3d213f3",
      "Sequence": 1,
      "AncestorCategoryId": "066d76ef-c325-4698-b6c2-5eedf88ac358",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "27553578-1945-4b56-8591-449d77c48799",
          "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": "27553578-1945-4b56-8591-449d77c48799",
          "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": "a1afb7ff-6e40-4056-a97f-ffe48996ae09",
    "CategoryId": "1a18397c-dba8-415d-afb3-cbce4ef263c8",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "29df4ee5-bb7a-4f54-bcf6-7388663f0f95",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "29df4ee5-bb7a-4f54-bcf6-7388663f0f95",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "6c41389b-10d8-4672-a290-684226bf7085",
      "Questions": [
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        },
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "6c41389b-10d8-4672-a290-684226bf7085",
      "Questions": [
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        },
        {
          "Id": "e696fe40-f373-4482-8017-f805cb044c75",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "004d4f69-eb29-4183-954b-dca621c029f7",
      "ContentItemId": "57eb4022-b604-4dbd-aa8a-e8fe86e42925",
      "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-08-16T06:42:04.6803579+00:00",
      "RescheduleDate": "2026-08-16T06:42:04.6803579+00:00"
    },
    {
      "Id": "004d4f69-eb29-4183-954b-dca621c029f7",
      "ContentItemId": "57eb4022-b604-4dbd-aa8a-e8fe86e42925",
      "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-08-16T06:42:04.6803579+00:00",
      "RescheduleDate": "2026-08-16T06:42:04.6803579+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}