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": "1070f473-a0bb-43da-a567-bb8716007472",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-21T19:37:52.6876906+00:00",
  "Registration": {
    "Id": "8bf741e8-5969-4fa8-8ebf-3447ef913c90",
    "UserId": "cb0de731-8e83-457d-8710-7cec291f7643",
    "IsCurrent": true,
    "CenterId": "2a9a9888-f42a-4a6d-a927-e15547f6e72a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "f50a81ca-f187-4416-95fe-8b6876c694ce",
    "EndDate": "2026-08-21T19:37:52.6876906+00:00",
    "StartDate": "2026-08-21T19:37:52.6876906+00:00",
    "SchedulePreferenceDate": "2026-08-21T19:37:52.6876906+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-21T19:37:52.6876906+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "b058c73a-8aeb-455c-8275-c1782a415132",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1c2dc2d2-b39f-4c51-b26e-e605af97e4da",
      "Sequence": 1,
      "AncestorCategoryId": "b21ba06a-f939-42a9-8743-34401ceb7fb6",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "b058c73a-8aeb-455c-8275-c1782a415132",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1c2dc2d2-b39f-4c51-b26e-e605af97e4da",
      "Sequence": 1,
      "AncestorCategoryId": "b21ba06a-f939-42a9-8743-34401ceb7fb6",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "e65e9ff3-4be1-4b28-b53d-b015373f36c2",
    "CategoryId": "4ea62d72-30e6-4c68-8b7a-b0481d0bdb22",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "85d59c09-fdfb-4016-b990-6ff89b38bb6a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "85d59c09-fdfb-4016-b990-6ff89b38bb6a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "9b760183-4fff-4981-a9f3-e5fa9ff3ac1b",
      "Questions": [
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "9b760183-4fff-4981-a9f3-e5fa9ff3ac1b",
      "Questions": [
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "28ab06ce-fb25-4826-8b41-87a27058f5c1",
      "ContentItemId": "513a5b79-9017-45b1-8a3f-f9404bb18685",
      "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-21T19:37:52.6876906+00:00",
      "RescheduleDate": "2026-08-21T19:37:52.6876906+00:00"
    },
    {
      "Id": "28ab06ce-fb25-4826-8b41-87a27058f5c1",
      "ContentItemId": "513a5b79-9017-45b1-8a3f-f9404bb18685",
      "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-21T19:37:52.6876906+00:00",
      "RescheduleDate": "2026-08-21T19:37:52.6876906+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "1070f473-a0bb-43da-a567-bb8716007472",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-21T19:37:52.7189433+00:00",
  "Registration": {
    "Id": "8bf741e8-5969-4fa8-8ebf-3447ef913c90",
    "UserId": "cb0de731-8e83-457d-8710-7cec291f7643",
    "IsCurrent": true,
    "CenterId": "2a9a9888-f42a-4a6d-a927-e15547f6e72a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "f50a81ca-f187-4416-95fe-8b6876c694ce",
    "EndDate": "2026-08-21T19:37:52.6876906+00:00",
    "StartDate": "2026-08-21T19:37:52.6876906+00:00",
    "SchedulePreferenceDate": "2026-08-21T19:37:52.6876906+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-21T19:37:52.6876906+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "b058c73a-8aeb-455c-8275-c1782a415132",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1c2dc2d2-b39f-4c51-b26e-e605af97e4da",
      "Sequence": 1,
      "AncestorCategoryId": "b21ba06a-f939-42a9-8743-34401ceb7fb6",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "b058c73a-8aeb-455c-8275-c1782a415132",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1c2dc2d2-b39f-4c51-b26e-e605af97e4da",
      "Sequence": 1,
      "AncestorCategoryId": "b21ba06a-f939-42a9-8743-34401ceb7fb6",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "1fad726d-a10a-4f30-9aad-1351f34c94fe",
          "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": "e65e9ff3-4be1-4b28-b53d-b015373f36c2",
    "CategoryId": "4ea62d72-30e6-4c68-8b7a-b0481d0bdb22",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "85d59c09-fdfb-4016-b990-6ff89b38bb6a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "85d59c09-fdfb-4016-b990-6ff89b38bb6a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "9b760183-4fff-4981-a9f3-e5fa9ff3ac1b",
      "Questions": [
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "9b760183-4fff-4981-a9f3-e5fa9ff3ac1b",
      "Questions": [
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b62a86e-bd9a-46eb-a2ba-c589c450e23e",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "28ab06ce-fb25-4826-8b41-87a27058f5c1",
      "ContentItemId": "513a5b79-9017-45b1-8a3f-f9404bb18685",
      "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-21T19:37:52.6876906+00:00",
      "RescheduleDate": "2026-08-21T19:37:52.6876906+00:00"
    },
    {
      "Id": "28ab06ce-fb25-4826-8b41-87a27058f5c1",
      "ContentItemId": "513a5b79-9017-45b1-8a3f-f9404bb18685",
      "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-21T19:37:52.6876906+00:00",
      "RescheduleDate": "2026-08-21T19:37:52.6876906+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}