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": "4e774387-2636-4194-abb0-1e7f07e0390a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-04T11:17:25.7065424+00:00",
  "Registration": {
    "Id": "660b7f9e-d457-4084-bfef-67485ba507e2",
    "UserId": "15cd73bd-83e8-4992-bfab-be44c1fc131d",
    "IsCurrent": true,
    "CenterId": "c54fe3e8-8c09-4e73-806f-57e198ac50e8",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "01758104-59f9-494a-8418-e80ac11b047b",
    "EndDate": "2026-08-04T11:17:25.6909168+00:00",
    "StartDate": "2026-08-04T11:17:25.6909168+00:00",
    "SchedulePreferenceDate": "2026-08-04T11:17:25.6909168+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-04T11:17:25.6909168+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "3156c6ed-28f5-480a-9a17-687f57081015",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3b8523c0-397c-4805-b273-d142ce1e52f1",
      "Sequence": 1,
      "AncestorCategoryId": "088918dc-828a-4eb7-8732-ceef379e9716",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "3156c6ed-28f5-480a-9a17-687f57081015",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3b8523c0-397c-4805-b273-d142ce1e52f1",
      "Sequence": 1,
      "AncestorCategoryId": "088918dc-828a-4eb7-8732-ceef379e9716",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "28da0eb9-c356-458a-a1cc-d91c4d18e235",
    "CategoryId": "19aec525-8ccb-446d-b4a0-8e3d3fad5b71",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "760601df-36d2-48b9-a51e-61a4928cc494",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "760601df-36d2-48b9-a51e-61a4928cc494",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "a1e3ec71-7a5f-41d4-bf55-0001ac1a5c89",
      "Questions": [
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        },
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "a1e3ec71-7a5f-41d4-bf55-0001ac1a5c89",
      "Questions": [
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        },
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "64a42a26-1bec-4c49-900f-385740e6c407",
      "ContentItemId": "5d6f734d-e048-4ede-8ea6-4b7c27e47204",
      "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-04T11:17:25.6909168+00:00",
      "RescheduleDate": "2026-08-04T11:17:25.6909168+00:00"
    },
    {
      "Id": "64a42a26-1bec-4c49-900f-385740e6c407",
      "ContentItemId": "5d6f734d-e048-4ede-8ea6-4b7c27e47204",
      "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-04T11:17:25.6909168+00:00",
      "RescheduleDate": "2026-08-04T11:17:25.6909168+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "4e774387-2636-4194-abb0-1e7f07e0390a",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-04T11:17:25.7534195+00:00",
  "Registration": {
    "Id": "660b7f9e-d457-4084-bfef-67485ba507e2",
    "UserId": "15cd73bd-83e8-4992-bfab-be44c1fc131d",
    "IsCurrent": true,
    "CenterId": "c54fe3e8-8c09-4e73-806f-57e198ac50e8",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "01758104-59f9-494a-8418-e80ac11b047b",
    "EndDate": "2026-08-04T11:17:25.6909168+00:00",
    "StartDate": "2026-08-04T11:17:25.6909168+00:00",
    "SchedulePreferenceDate": "2026-08-04T11:17:25.6909168+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-04T11:17:25.6909168+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "3156c6ed-28f5-480a-9a17-687f57081015",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3b8523c0-397c-4805-b273-d142ce1e52f1",
      "Sequence": 1,
      "AncestorCategoryId": "088918dc-828a-4eb7-8732-ceef379e9716",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "3156c6ed-28f5-480a-9a17-687f57081015",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "3b8523c0-397c-4805-b273-d142ce1e52f1",
      "Sequence": 1,
      "AncestorCategoryId": "088918dc-828a-4eb7-8732-ceef379e9716",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "ccf81680-9cf5-4350-8a49-57f9c461eaea",
          "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": "28da0eb9-c356-458a-a1cc-d91c4d18e235",
    "CategoryId": "19aec525-8ccb-446d-b4a0-8e3d3fad5b71",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "760601df-36d2-48b9-a51e-61a4928cc494",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "760601df-36d2-48b9-a51e-61a4928cc494",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "a1e3ec71-7a5f-41d4-bf55-0001ac1a5c89",
      "Questions": [
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        },
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "a1e3ec71-7a5f-41d4-bf55-0001ac1a5c89",
      "Questions": [
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        },
        {
          "Id": "eee43266-f88c-4602-9d92-719f8c31658d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "64a42a26-1bec-4c49-900f-385740e6c407",
      "ContentItemId": "5d6f734d-e048-4ede-8ea6-4b7c27e47204",
      "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-04T11:17:25.6909168+00:00",
      "RescheduleDate": "2026-08-04T11:17:25.6909168+00:00"
    },
    {
      "Id": "64a42a26-1bec-4c49-900f-385740e6c407",
      "ContentItemId": "5d6f734d-e048-4ede-8ea6-4b7c27e47204",
      "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-04T11:17:25.6909168+00:00",
      "RescheduleDate": "2026-08-04T11:17:25.6909168+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}