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": "cd384843-e722-48e3-a519-b1c4cee7bbed",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-11T21:31:08.6559969+00:00",
  "Registration": {
    "Id": "21b38ed8-349c-45b7-98d5-1b18a8dfd5de",
    "UserId": "7b458638-a0fb-4a3c-a514-cf64d50cdafc",
    "IsCurrent": true,
    "CenterId": "bceea5b5-f9ec-4a59-ac1e-0555c8196bf3",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "936ee1b2-e76c-4a30-8ba1-08c95a94b3bb",
    "EndDate": "2026-05-11T21:31:08.6559969+00:00",
    "StartDate": "2026-05-11T21:31:08.6559969+00:00",
    "SchedulePreferenceDate": "2026-05-11T21:31:08.6559969+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-11T21:31:08.6559969+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e41363cb-090c-4e54-aa64-9da8a903a804",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5e166225-84f2-4fd9-bd76-d9f1ade42ab7",
      "Sequence": 1,
      "AncestorCategoryId": "064eed84-714d-4c47-84f6-ad97055f2ddd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "e41363cb-090c-4e54-aa64-9da8a903a804",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5e166225-84f2-4fd9-bd76-d9f1ade42ab7",
      "Sequence": 1,
      "AncestorCategoryId": "064eed84-714d-4c47-84f6-ad97055f2ddd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "e1186b93-3faa-4b2a-9537-ad81250981cc",
    "CategoryId": "1b8d8118-bb90-4123-8cb3-eaa489c7bfe3",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0c2bb2be-32a9-445f-8450-f3d51c78b2ea",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0c2bb2be-32a9-445f-8450-f3d51c78b2ea",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "81a0f1f8-e8a1-42a6-8e89-22b66eff8233",
      "Questions": [
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        },
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "81a0f1f8-e8a1-42a6-8e89-22b66eff8233",
      "Questions": [
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        },
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "9625629f-eb01-48dc-a69d-06a38ed1a39d",
      "ContentItemId": "9ed15d80-dcd1-454e-b79e-90bc13884e79",
      "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-11T21:31:08.6559969+00:00",
      "RescheduleDate": "2026-05-11T21:31:08.6559969+00:00"
    },
    {
      "Id": "9625629f-eb01-48dc-a69d-06a38ed1a39d",
      "ContentItemId": "9ed15d80-dcd1-454e-b79e-90bc13884e79",
      "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-11T21:31:08.6559969+00:00",
      "RescheduleDate": "2026-05-11T21:31:08.6559969+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "cd384843-e722-48e3-a519-b1c4cee7bbed",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-11T21:31:08.6872315+00:00",
  "Registration": {
    "Id": "21b38ed8-349c-45b7-98d5-1b18a8dfd5de",
    "UserId": "7b458638-a0fb-4a3c-a514-cf64d50cdafc",
    "IsCurrent": true,
    "CenterId": "bceea5b5-f9ec-4a59-ac1e-0555c8196bf3",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "936ee1b2-e76c-4a30-8ba1-08c95a94b3bb",
    "EndDate": "2026-05-11T21:31:08.6559969+00:00",
    "StartDate": "2026-05-11T21:31:08.6559969+00:00",
    "SchedulePreferenceDate": "2026-05-11T21:31:08.6559969+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-11T21:31:08.6559969+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e41363cb-090c-4e54-aa64-9da8a903a804",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5e166225-84f2-4fd9-bd76-d9f1ade42ab7",
      "Sequence": 1,
      "AncestorCategoryId": "064eed84-714d-4c47-84f6-ad97055f2ddd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "e41363cb-090c-4e54-aa64-9da8a903a804",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5e166225-84f2-4fd9-bd76-d9f1ade42ab7",
      "Sequence": 1,
      "AncestorCategoryId": "064eed84-714d-4c47-84f6-ad97055f2ddd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "528017e2-0776-42f5-ae94-90b77f8ed811",
          "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": "e1186b93-3faa-4b2a-9537-ad81250981cc",
    "CategoryId": "1b8d8118-bb90-4123-8cb3-eaa489c7bfe3",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0c2bb2be-32a9-445f-8450-f3d51c78b2ea",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0c2bb2be-32a9-445f-8450-f3d51c78b2ea",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "81a0f1f8-e8a1-42a6-8e89-22b66eff8233",
      "Questions": [
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        },
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "81a0f1f8-e8a1-42a6-8e89-22b66eff8233",
      "Questions": [
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        },
        {
          "Id": "70eb9418-58de-4a5e-9acb-4853d6789928",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "9625629f-eb01-48dc-a69d-06a38ed1a39d",
      "ContentItemId": "9ed15d80-dcd1-454e-b79e-90bc13884e79",
      "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-11T21:31:08.6559969+00:00",
      "RescheduleDate": "2026-05-11T21:31:08.6559969+00:00"
    },
    {
      "Id": "9625629f-eb01-48dc-a69d-06a38ed1a39d",
      "ContentItemId": "9ed15d80-dcd1-454e-b79e-90bc13884e79",
      "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-11T21:31:08.6559969+00:00",
      "RescheduleDate": "2026-05-11T21:31:08.6559969+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}