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": "baea6600-70f6-48a2-ba1f-abe8b2bd11ee",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-26T18:00:26.3110641+00:00",
  "Registration": {
    "Id": "c8112213-3225-4d72-835a-cba6673d70a3",
    "UserId": "14f18492-67eb-4a6a-96c6-3d442783acd9",
    "IsCurrent": true,
    "CenterId": "1adc1976-5268-4dda-8991-081e22098ae8",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b102cc6b-8849-450a-af6d-d6b0d426ea86",
    "EndDate": "2026-08-26T18:00:26.2954395+00:00",
    "StartDate": "2026-08-26T18:00:26.2954395+00:00",
    "SchedulePreferenceDate": "2026-08-26T18:00:26.2954395+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-26T18:00:26.2954395+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "69cd3f1f-3200-4aa2-ba76-ab25cf8b80d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4bf83464-28a4-49a6-a2fd-d081ec23f588",
      "Sequence": 1,
      "AncestorCategoryId": "6b4e0de4-fe62-4f4f-94ff-c7848ca4cbec",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "69cd3f1f-3200-4aa2-ba76-ab25cf8b80d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4bf83464-28a4-49a6-a2fd-d081ec23f588",
      "Sequence": 1,
      "AncestorCategoryId": "6b4e0de4-fe62-4f4f-94ff-c7848ca4cbec",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "7373264d-dfec-4eb6-8441-ff7ca7c07b5d",
    "CategoryId": "5690cc02-d5f5-4657-84be-47b4b4c4fef4",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "b9bad4aa-75f8-478e-b56e-f334be206472",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "b9bad4aa-75f8-478e-b56e-f334be206472",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c37acae4-1fba-4b3f-9cca-9582aaf15776",
      "Questions": [
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c37acae4-1fba-4b3f-9cca-9582aaf15776",
      "Questions": [
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cb9aa860-1f79-4515-b125-c6db2a9d59a0",
      "ContentItemId": "eadb73fc-992a-4c8f-a444-6d7c0c758a5b",
      "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-26T18:00:26.2954395+00:00",
      "RescheduleDate": "2026-08-26T18:00:26.2954395+00:00"
    },
    {
      "Id": "cb9aa860-1f79-4515-b125-c6db2a9d59a0",
      "ContentItemId": "eadb73fc-992a-4c8f-a444-6d7c0c758a5b",
      "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-26T18:00:26.2954395+00:00",
      "RescheduleDate": "2026-08-26T18:00:26.2954395+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "baea6600-70f6-48a2-ba1f-abe8b2bd11ee",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-26T18:00:26.3423122+00:00",
  "Registration": {
    "Id": "c8112213-3225-4d72-835a-cba6673d70a3",
    "UserId": "14f18492-67eb-4a6a-96c6-3d442783acd9",
    "IsCurrent": true,
    "CenterId": "1adc1976-5268-4dda-8991-081e22098ae8",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b102cc6b-8849-450a-af6d-d6b0d426ea86",
    "EndDate": "2026-08-26T18:00:26.2954395+00:00",
    "StartDate": "2026-08-26T18:00:26.2954395+00:00",
    "SchedulePreferenceDate": "2026-08-26T18:00:26.2954395+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-26T18:00:26.2954395+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "69cd3f1f-3200-4aa2-ba76-ab25cf8b80d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4bf83464-28a4-49a6-a2fd-d081ec23f588",
      "Sequence": 1,
      "AncestorCategoryId": "6b4e0de4-fe62-4f4f-94ff-c7848ca4cbec",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "69cd3f1f-3200-4aa2-ba76-ab25cf8b80d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4bf83464-28a4-49a6-a2fd-d081ec23f588",
      "Sequence": 1,
      "AncestorCategoryId": "6b4e0de4-fe62-4f4f-94ff-c7848ca4cbec",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "5466e223-c473-4b08-a7ca-a904de8a2862",
          "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": "7373264d-dfec-4eb6-8441-ff7ca7c07b5d",
    "CategoryId": "5690cc02-d5f5-4657-84be-47b4b4c4fef4",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "b9bad4aa-75f8-478e-b56e-f334be206472",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "b9bad4aa-75f8-478e-b56e-f334be206472",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c37acae4-1fba-4b3f-9cca-9582aaf15776",
      "Questions": [
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c37acae4-1fba-4b3f-9cca-9582aaf15776",
      "Questions": [
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        },
        {
          "Id": "9c29ae36-9257-4059-bd1e-fc667c1ad4be",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cb9aa860-1f79-4515-b125-c6db2a9d59a0",
      "ContentItemId": "eadb73fc-992a-4c8f-a444-6d7c0c758a5b",
      "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-26T18:00:26.2954395+00:00",
      "RescheduleDate": "2026-08-26T18:00:26.2954395+00:00"
    },
    {
      "Id": "cb9aa860-1f79-4515-b125-c6db2a9d59a0",
      "ContentItemId": "eadb73fc-992a-4c8f-a444-6d7c0c758a5b",
      "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-26T18:00:26.2954395+00:00",
      "RescheduleDate": "2026-08-26T18:00:26.2954395+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}