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": "c4c95c85-b38f-4529-bc1d-1dbe369efb86",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-08T18:39:07.5058536+00:00",
  "Registration": [
    {
      "Id": "b1fc4e32-7443-44be-8753-600730ffa32d",
      "UserId": "92792a8b-00db-4074-b4d1-181926535921",
      "IsCurrent": true,
      "CenterId": "6bccd3d3-5523-4eb6-9612-fd0343602278",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "6d8f0af5-3207-44c5-9212-a79ca08e1846",
      "EndDate": "2026-05-08T18:39:07.4902298+00:00",
      "StartDate": "2026-05-08T18:39:07.4902298+00:00",
      "SchedulePreferenceDate": "2026-05-08T18:39:07.4902298+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": "b1fc4e32-7443-44be-8753-600730ffa32d",
      "UserId": "92792a8b-00db-4074-b4d1-181926535921",
      "IsCurrent": true,
      "CenterId": "6bccd3d3-5523-4eb6-9612-fd0343602278",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "6d8f0af5-3207-44c5-9212-a79ca08e1846",
      "EndDate": "2026-05-08T18:39:07.4902298+00:00",
      "StartDate": "2026-05-08T18:39:07.4902298+00:00",
      "SchedulePreferenceDate": "2026-05-08T18:39:07.4902298+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-05-08T18:39:07.4902298+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f2b68310-b284-4779-999e-2cc3788ee530",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "77e39ab5-8542-45f3-8e75-cfc8d9651355",
      "Sequence": 1,
      "AncestorCategoryId": "e5a25c9e-a329-4772-a0b9-45142ce6a63a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "f2b68310-b284-4779-999e-2cc3788ee530",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "77e39ab5-8542-45f3-8e75-cfc8d9651355",
      "Sequence": 1,
      "AncestorCategoryId": "e5a25c9e-a329-4772-a0b9-45142ce6a63a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "c67288f4-7a14-4685-b6ca-2293bff0e34b",
    "CategoryId": "7b78c9c9-9c6d-4f07-885c-031ae4cee759",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "487137cc-1416-4739-9ba9-86ff6fdea3a9",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "487137cc-1416-4739-9ba9-86ff6fdea3a9",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "bbe0a7f5-01c8-4c5e-a058-f5b4f4121fcd",
      "Questions": [
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        },
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "bbe0a7f5-01c8-4c5e-a058-f5b4f4121fcd",
      "Questions": [
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        },
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7b9d6520-a205-48a1-8de3-91ea7f710bfd",
      "ContentItemId": "ce743e13-c8a0-4eb8-8fe1-e04019d3a43d",
      "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-05-08T18:39:07.4902298+00:00",
      "RescheduleDate": "2026-05-08T18:39:07.4902298+00:00"
    },
    {
      "Id": "7b9d6520-a205-48a1-8de3-91ea7f710bfd",
      "ContentItemId": "ce743e13-c8a0-4eb8-8fe1-e04019d3a43d",
      "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-05-08T18:39:07.4902298+00:00",
      "RescheduleDate": "2026-05-08T18:39:07.4902298+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": "c4c95c85-b38f-4529-bc1d-1dbe369efb86",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-08T18:39:07.537103+00:00",
  "Registration": [
    {
      "Id": "b1fc4e32-7443-44be-8753-600730ffa32d",
      "UserId": "92792a8b-00db-4074-b4d1-181926535921",
      "IsCurrent": true,
      "CenterId": "6bccd3d3-5523-4eb6-9612-fd0343602278",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "6d8f0af5-3207-44c5-9212-a79ca08e1846",
      "EndDate": "2026-05-08T18:39:07.4902298+00:00",
      "StartDate": "2026-05-08T18:39:07.4902298+00:00",
      "SchedulePreferenceDate": "2026-05-08T18:39:07.4902298+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": "b1fc4e32-7443-44be-8753-600730ffa32d",
      "UserId": "92792a8b-00db-4074-b4d1-181926535921",
      "IsCurrent": true,
      "CenterId": "6bccd3d3-5523-4eb6-9612-fd0343602278",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "6d8f0af5-3207-44c5-9212-a79ca08e1846",
      "EndDate": "2026-05-08T18:39:07.4902298+00:00",
      "StartDate": "2026-05-08T18:39:07.4902298+00:00",
      "SchedulePreferenceDate": "2026-05-08T18:39:07.4902298+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-05-08T18:39:07.4902298+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f2b68310-b284-4779-999e-2cc3788ee530",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "77e39ab5-8542-45f3-8e75-cfc8d9651355",
      "Sequence": 1,
      "AncestorCategoryId": "e5a25c9e-a329-4772-a0b9-45142ce6a63a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "f2b68310-b284-4779-999e-2cc3788ee530",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "77e39ab5-8542-45f3-8e75-cfc8d9651355",
      "Sequence": 1,
      "AncestorCategoryId": "e5a25c9e-a329-4772-a0b9-45142ce6a63a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "996dba8e-bd4b-43fb-bd17-1010b303b20f",
          "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": "c67288f4-7a14-4685-b6ca-2293bff0e34b",
    "CategoryId": "7b78c9c9-9c6d-4f07-885c-031ae4cee759",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "487137cc-1416-4739-9ba9-86ff6fdea3a9",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "487137cc-1416-4739-9ba9-86ff6fdea3a9",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "bbe0a7f5-01c8-4c5e-a058-f5b4f4121fcd",
      "Questions": [
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        },
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "bbe0a7f5-01c8-4c5e-a058-f5b4f4121fcd",
      "Questions": [
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        },
        {
          "Id": "e26e0b93-c75d-4d3d-bc19-ea8d86f2d9e9",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7b9d6520-a205-48a1-8de3-91ea7f710bfd",
      "ContentItemId": "ce743e13-c8a0-4eb8-8fe1-e04019d3a43d",
      "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-05-08T18:39:07.4902298+00:00",
      "RescheduleDate": "2026-05-08T18:39:07.4902298+00:00"
    },
    {
      "Id": "7b9d6520-a205-48a1-8de3-91ea7f710bfd",
      "ContentItemId": "ce743e13-c8a0-4eb8-8fe1-e04019d3a43d",
      "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-05-08T18:39:07.4902298+00:00",
      "RescheduleDate": "2026-05-08T18:39:07.4902298+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}