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": "ccc01937-67f4-4d5e-8551-9bc4f20e8e0a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-01T11:34:14.3266325+00:00",
  "Registration": [
    {
      "Id": "be09a18f-a178-4090-9d84-9d927d174a16",
      "UserId": "737d1d65-4457-4408-9e60-b49bdd752222",
      "IsCurrent": true,
      "CenterId": "5a9dbd00-1afa-45f8-9480-4e8258a265fc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a2f59aa6-8b0e-44e7-b9a3-134a991e622a",
      "EndDate": "2026-08-01T11:34:14.3266325+00:00",
      "StartDate": "2026-08-01T11:34:14.3266325+00:00",
      "SchedulePreferenceDate": "2026-08-01T11:34:14.3266325+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": "be09a18f-a178-4090-9d84-9d927d174a16",
      "UserId": "737d1d65-4457-4408-9e60-b49bdd752222",
      "IsCurrent": true,
      "CenterId": "5a9dbd00-1afa-45f8-9480-4e8258a265fc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a2f59aa6-8b0e-44e7-b9a3-134a991e622a",
      "EndDate": "2026-08-01T11:34:14.3266325+00:00",
      "StartDate": "2026-08-01T11:34:14.3266325+00:00",
      "SchedulePreferenceDate": "2026-08-01T11:34:14.3266325+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-01T11:34:14.3266325+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "900e6487-ca89-447f-bfb3-df30671e0c46",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b05f8da5-b05b-4ee6-8fd7-d531cf7e2335",
      "Sequence": 1,
      "AncestorCategoryId": "2b5d7c13-3d9b-4a68-b4c5-547d696d3ee0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "900e6487-ca89-447f-bfb3-df30671e0c46",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b05f8da5-b05b-4ee6-8fd7-d531cf7e2335",
      "Sequence": 1,
      "AncestorCategoryId": "2b5d7c13-3d9b-4a68-b4c5-547d696d3ee0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "c80e2eb2-9f75-4abb-8fd6-1e0efe954d51",
    "CategoryId": "6a4caa3f-7b37-4f7c-b142-330395f82100",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "fbec9ee6-4e88-4e30-b88a-a765e06f6aaa",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "fbec9ee6-4e88-4e30-b88a-a765e06f6aaa",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7be88861-886c-4da6-8943-f8346769d35a",
      "Questions": [
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        },
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7be88861-886c-4da6-8943-f8346769d35a",
      "Questions": [
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        },
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ed9f51ca-5c96-4e70-a856-b5104d2c90e5",
      "ContentItemId": "d338509f-c931-4d0c-8e27-d0aaabcb1f66",
      "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-01T11:34:14.3266325+00:00",
      "RescheduleDate": "2026-08-01T11:34:14.3266325+00:00"
    },
    {
      "Id": "ed9f51ca-5c96-4e70-a856-b5104d2c90e5",
      "ContentItemId": "d338509f-c931-4d0c-8e27-d0aaabcb1f66",
      "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-01T11:34:14.3266325+00:00",
      "RescheduleDate": "2026-08-01T11:34:14.3266325+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": "ccc01937-67f4-4d5e-8551-9bc4f20e8e0a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-01T11:34:14.3422602+00:00",
  "Registration": [
    {
      "Id": "be09a18f-a178-4090-9d84-9d927d174a16",
      "UserId": "737d1d65-4457-4408-9e60-b49bdd752222",
      "IsCurrent": true,
      "CenterId": "5a9dbd00-1afa-45f8-9480-4e8258a265fc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a2f59aa6-8b0e-44e7-b9a3-134a991e622a",
      "EndDate": "2026-08-01T11:34:14.3266325+00:00",
      "StartDate": "2026-08-01T11:34:14.3266325+00:00",
      "SchedulePreferenceDate": "2026-08-01T11:34:14.3266325+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": "be09a18f-a178-4090-9d84-9d927d174a16",
      "UserId": "737d1d65-4457-4408-9e60-b49bdd752222",
      "IsCurrent": true,
      "CenterId": "5a9dbd00-1afa-45f8-9480-4e8258a265fc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a2f59aa6-8b0e-44e7-b9a3-134a991e622a",
      "EndDate": "2026-08-01T11:34:14.3266325+00:00",
      "StartDate": "2026-08-01T11:34:14.3266325+00:00",
      "SchedulePreferenceDate": "2026-08-01T11:34:14.3266325+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-01T11:34:14.3266325+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "900e6487-ca89-447f-bfb3-df30671e0c46",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b05f8da5-b05b-4ee6-8fd7-d531cf7e2335",
      "Sequence": 1,
      "AncestorCategoryId": "2b5d7c13-3d9b-4a68-b4c5-547d696d3ee0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "900e6487-ca89-447f-bfb3-df30671e0c46",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b05f8da5-b05b-4ee6-8fd7-d531cf7e2335",
      "Sequence": 1,
      "AncestorCategoryId": "2b5d7c13-3d9b-4a68-b4c5-547d696d3ee0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "7c2e2862-9bb3-4460-b3d3-262391bfb2f6",
          "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": "c80e2eb2-9f75-4abb-8fd6-1e0efe954d51",
    "CategoryId": "6a4caa3f-7b37-4f7c-b142-330395f82100",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "fbec9ee6-4e88-4e30-b88a-a765e06f6aaa",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "fbec9ee6-4e88-4e30-b88a-a765e06f6aaa",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7be88861-886c-4da6-8943-f8346769d35a",
      "Questions": [
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        },
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7be88861-886c-4da6-8943-f8346769d35a",
      "Questions": [
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        },
        {
          "Id": "19fd3a12-7f77-42a5-b6ec-ce9dc6112e2f",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ed9f51ca-5c96-4e70-a856-b5104d2c90e5",
      "ContentItemId": "d338509f-c931-4d0c-8e27-d0aaabcb1f66",
      "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-01T11:34:14.3266325+00:00",
      "RescheduleDate": "2026-08-01T11:34:14.3266325+00:00"
    },
    {
      "Id": "ed9f51ca-5c96-4e70-a856-b5104d2c90e5",
      "ContentItemId": "d338509f-c931-4d0c-8e27-d0aaabcb1f66",
      "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-01T11:34:14.3266325+00:00",
      "RescheduleDate": "2026-08-01T11:34:14.3266325+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}