GET 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.Views.UserStateBackwardCompatibleViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

IsNewUser

boolean

None.

UserName

string

None.

PrivacyPolicyApprove

boolean

None.

ServerTime

date

None.

Registration

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.

Response Formats

application/json

Sample:
{
  "UserId": "b1201403-3a62-44f3-8cbd-43c325731e75",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-20T22:10:58.1748778+00:00",
  "Registration": {
    "Id": "075ca02b-f55a-4499-b9f0-9d6f981dd44c",
    "UserId": "8d28b332-c53e-428f-b5a2-4fd9e3822327",
    "IsCurrent": true,
    "CenterId": "8bd92c4e-a7b8-4e57-9b27-350c0b44e61a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "1226ee5b-752b-44a5-80c2-727d6898d26f",
    "EndDate": "2026-07-20T22:10:58.1748778+00:00",
    "StartDate": "2026-07-20T22:10:58.1748778+00:00",
    "SchedulePreferenceDate": "2026-07-20T22:10:58.1748778+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-07-20T22:10:58.1748778+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a057b63b-e97f-4032-b68c-12a7434a13d0",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35fcffa8-62a7-4591-8324-7efd7373905c",
      "Sequence": 1,
      "AncestorCategoryId": "ccba08c4-ff41-4b6f-872f-ebb408fc95f2",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "a057b63b-e97f-4032-b68c-12a7434a13d0",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35fcffa8-62a7-4591-8324-7efd7373905c",
      "Sequence": 1,
      "AncestorCategoryId": "ccba08c4-ff41-4b6f-872f-ebb408fc95f2",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "b9f65437-bd57-4e96-8623-31b67f2357d5",
    "CategoryId": "4ffce7e0-fdb6-4ebd-888e-bbe07d0ca468",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "dc8a902a-eeb8-4632-9988-b306fd3c72b0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "dc8a902a-eeb8-4632-9988-b306fd3c72b0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "805d07e5-bc7a-4a98-b16d-9a451920ddaa",
      "Questions": [
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        },
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "805d07e5-bc7a-4a98-b16d-9a451920ddaa",
      "Questions": [
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        },
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1353fa33-4477-454b-94ab-6fbce4edbf9a",
      "ContentItemId": "7b65c64b-f838-4cdb-aa8e-fd999027a044",
      "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-07-20T22:10:58.1748778+00:00",
      "RescheduleDate": "2026-07-20T22:10:58.1748778+00:00"
    },
    {
      "Id": "1353fa33-4477-454b-94ab-6fbce4edbf9a",
      "ContentItemId": "7b65c64b-f838-4cdb-aa8e-fd999027a044",
      "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-07-20T22:10:58.1748778+00:00",
      "RescheduleDate": "2026-07-20T22:10:58.1748778+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "b1201403-3a62-44f3-8cbd-43c325731e75",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-20T22:10:58.2061279+00:00",
  "Registration": {
    "Id": "075ca02b-f55a-4499-b9f0-9d6f981dd44c",
    "UserId": "8d28b332-c53e-428f-b5a2-4fd9e3822327",
    "IsCurrent": true,
    "CenterId": "8bd92c4e-a7b8-4e57-9b27-350c0b44e61a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "1226ee5b-752b-44a5-80c2-727d6898d26f",
    "EndDate": "2026-07-20T22:10:58.1748778+00:00",
    "StartDate": "2026-07-20T22:10:58.1748778+00:00",
    "SchedulePreferenceDate": "2026-07-20T22:10:58.1748778+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-07-20T22:10:58.1748778+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a057b63b-e97f-4032-b68c-12a7434a13d0",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35fcffa8-62a7-4591-8324-7efd7373905c",
      "Sequence": 1,
      "AncestorCategoryId": "ccba08c4-ff41-4b6f-872f-ebb408fc95f2",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "a057b63b-e97f-4032-b68c-12a7434a13d0",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35fcffa8-62a7-4591-8324-7efd7373905c",
      "Sequence": 1,
      "AncestorCategoryId": "ccba08c4-ff41-4b6f-872f-ebb408fc95f2",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "1b37a16b-5216-4278-b35b-265170cade63",
          "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": "b9f65437-bd57-4e96-8623-31b67f2357d5",
    "CategoryId": "4ffce7e0-fdb6-4ebd-888e-bbe07d0ca468",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "dc8a902a-eeb8-4632-9988-b306fd3c72b0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "dc8a902a-eeb8-4632-9988-b306fd3c72b0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "805d07e5-bc7a-4a98-b16d-9a451920ddaa",
      "Questions": [
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        },
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "805d07e5-bc7a-4a98-b16d-9a451920ddaa",
      "Questions": [
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        },
        {
          "Id": "0a87177d-da9a-4e56-b431-a51773c9f97a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1353fa33-4477-454b-94ab-6fbce4edbf9a",
      "ContentItemId": "7b65c64b-f838-4cdb-aa8e-fd999027a044",
      "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-07-20T22:10:58.1748778+00:00",
      "RescheduleDate": "2026-07-20T22:10:58.1748778+00:00"
    },
    {
      "Id": "1353fa33-4477-454b-94ab-6fbce4edbf9a",
      "ContentItemId": "7b65c64b-f838-4cdb-aa8e-fd999027a044",
      "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-07-20T22:10:58.1748778+00:00",
      "RescheduleDate": "2026-07-20T22:10:58.1748778+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}