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": "ce31c3e1-e8b0-4a28-a91f-fa6d191e18dc",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-07T06:58:23.6765639+00:00",
  "Registration": {
    "Id": "5ba013d9-80ed-4d4a-85c7-f70ce624283c",
    "UserId": "cfdb9592-faf5-41ae-be64-d7b66dcf58c4",
    "IsCurrent": true,
    "CenterId": "990c193d-018a-4c3c-8310-427147e3b59e",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b4cb0704-3918-4961-85c4-31d22c772615",
    "EndDate": "2026-08-07T06:58:23.6609387+00:00",
    "StartDate": "2026-08-07T06:58:23.6609387+00:00",
    "SchedulePreferenceDate": "2026-08-07T06:58:23.6609387+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-07T06:58:23.6609387+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e13b4803-46fc-493b-9302-1a7dacc01f18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c527149a-01b2-4670-9a84-35a184f619fd",
      "Sequence": 1,
      "AncestorCategoryId": "043c0c9c-b359-42e5-9a04-f5eac5f5c959",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "e13b4803-46fc-493b-9302-1a7dacc01f18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c527149a-01b2-4670-9a84-35a184f619fd",
      "Sequence": 1,
      "AncestorCategoryId": "043c0c9c-b359-42e5-9a04-f5eac5f5c959",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "8f68c2a6-8e02-49d5-ae7f-f785441f5620",
    "CategoryId": "0eb9e2f4-d22f-46c1-ada0-ad280b87f6e3",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0026e529-2ade-4d97-839b-7c6e1a8f66cc",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0026e529-2ade-4d97-839b-7c6e1a8f66cc",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "cc1d23b0-a586-4d5e-9cb9-262e787376be",
      "Questions": [
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        },
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "cc1d23b0-a586-4d5e-9cb9-262e787376be",
      "Questions": [
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        },
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "bc3d65dd-ed52-4914-8703-508b050b631c",
      "ContentItemId": "dd1358eb-5aa6-496f-b42e-9ffd35cfe1ef",
      "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-07T06:58:23.6609387+00:00",
      "RescheduleDate": "2026-08-07T06:58:23.6609387+00:00"
    },
    {
      "Id": "bc3d65dd-ed52-4914-8703-508b050b631c",
      "ContentItemId": "dd1358eb-5aa6-496f-b42e-9ffd35cfe1ef",
      "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-07T06:58:23.6609387+00:00",
      "RescheduleDate": "2026-08-07T06:58:23.6609387+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "ce31c3e1-e8b0-4a28-a91f-fa6d191e18dc",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-07T06:58:23.7078139+00:00",
  "Registration": {
    "Id": "5ba013d9-80ed-4d4a-85c7-f70ce624283c",
    "UserId": "cfdb9592-faf5-41ae-be64-d7b66dcf58c4",
    "IsCurrent": true,
    "CenterId": "990c193d-018a-4c3c-8310-427147e3b59e",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b4cb0704-3918-4961-85c4-31d22c772615",
    "EndDate": "2026-08-07T06:58:23.6609387+00:00",
    "StartDate": "2026-08-07T06:58:23.6609387+00:00",
    "SchedulePreferenceDate": "2026-08-07T06:58:23.6609387+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-07T06:58:23.6609387+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e13b4803-46fc-493b-9302-1a7dacc01f18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c527149a-01b2-4670-9a84-35a184f619fd",
      "Sequence": 1,
      "AncestorCategoryId": "043c0c9c-b359-42e5-9a04-f5eac5f5c959",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "e13b4803-46fc-493b-9302-1a7dacc01f18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c527149a-01b2-4670-9a84-35a184f619fd",
      "Sequence": 1,
      "AncestorCategoryId": "043c0c9c-b359-42e5-9a04-f5eac5f5c959",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "1b561ade-0d09-4c73-a6a7-f190b13d759f",
          "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": "8f68c2a6-8e02-49d5-ae7f-f785441f5620",
    "CategoryId": "0eb9e2f4-d22f-46c1-ada0-ad280b87f6e3",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0026e529-2ade-4d97-839b-7c6e1a8f66cc",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0026e529-2ade-4d97-839b-7c6e1a8f66cc",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "cc1d23b0-a586-4d5e-9cb9-262e787376be",
      "Questions": [
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        },
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "cc1d23b0-a586-4d5e-9cb9-262e787376be",
      "Questions": [
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        },
        {
          "Id": "3d98e55e-40b2-43a5-81ee-83f7aa9ec56d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "bc3d65dd-ed52-4914-8703-508b050b631c",
      "ContentItemId": "dd1358eb-5aa6-496f-b42e-9ffd35cfe1ef",
      "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-07T06:58:23.6609387+00:00",
      "RescheduleDate": "2026-08-07T06:58:23.6609387+00:00"
    },
    {
      "Id": "bc3d65dd-ed52-4914-8703-508b050b631c",
      "ContentItemId": "dd1358eb-5aa6-496f-b42e-9ffd35cfe1ef",
      "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-07T06:58:23.6609387+00:00",
      "RescheduleDate": "2026-08-07T06:58:23.6609387+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}