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": "48f1b3e5-655d-4e79-9484-c431ea384a67",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-11T08:32:17.6426214+00:00",
  "Registration": {
    "Id": "621f6cc7-ae54-4be2-ae0e-b1d00b682dd9",
    "UserId": "6c5b81c1-9f6e-4e22-b753-33fa9d4c55e8",
    "IsCurrent": true,
    "CenterId": "c5a27522-af46-4d0e-822c-119f85563758",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "2981b931-f126-420c-b6b5-90d21004e123",
    "EndDate": "2026-05-11T08:32:17.6269949+00:00",
    "StartDate": "2026-05-11T08:32:17.6269949+00:00",
    "SchedulePreferenceDate": "2026-05-11T08:32:17.6269949+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-11T08:32:17.6269949+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "eb3fe3c2-9f29-4dc0-b104-720d81a524a9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "55e218be-3b31-4a1a-ae0a-ed16fd25d7b3",
      "Sequence": 1,
      "AncestorCategoryId": "3ac1e074-3a31-44ea-bb75-8a135e5cd922",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "eb3fe3c2-9f29-4dc0-b104-720d81a524a9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "55e218be-3b31-4a1a-ae0a-ed16fd25d7b3",
      "Sequence": 1,
      "AncestorCategoryId": "3ac1e074-3a31-44ea-bb75-8a135e5cd922",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "089d358d-a8b8-42b3-a295-dfe37db7d93d",
    "CategoryId": "0bfd4e11-3a0b-4ccd-b76e-52186eb8feb7",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "5dfa77f6-5cb2-4d1b-aa0d-59c33f2921ee",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "5dfa77f6-5cb2-4d1b-aa0d-59c33f2921ee",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7e29b4ba-ad19-4ea2-a64b-45eaa86d9750",
      "Questions": [
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        },
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7e29b4ba-ad19-4ea2-a64b-45eaa86d9750",
      "Questions": [
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        },
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "c076eead-e9d3-4952-8bc3-0eb0525b6d2f",
      "ContentItemId": "587081c8-60a9-4f48-95d6-fbcc24a1c3b6",
      "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-11T08:32:17.6426214+00:00",
      "RescheduleDate": "2026-05-11T08:32:17.6426214+00:00"
    },
    {
      "Id": "c076eead-e9d3-4952-8bc3-0eb0525b6d2f",
      "ContentItemId": "587081c8-60a9-4f48-95d6-fbcc24a1c3b6",
      "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-11T08:32:17.6426214+00:00",
      "RescheduleDate": "2026-05-11T08:32:17.6426214+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "48f1b3e5-655d-4e79-9484-c431ea384a67",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-05-11T08:32:17.7051197+00:00",
  "Registration": {
    "Id": "621f6cc7-ae54-4be2-ae0e-b1d00b682dd9",
    "UserId": "6c5b81c1-9f6e-4e22-b753-33fa9d4c55e8",
    "IsCurrent": true,
    "CenterId": "c5a27522-af46-4d0e-822c-119f85563758",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "2981b931-f126-420c-b6b5-90d21004e123",
    "EndDate": "2026-05-11T08:32:17.6269949+00:00",
    "StartDate": "2026-05-11T08:32:17.6269949+00:00",
    "SchedulePreferenceDate": "2026-05-11T08:32:17.6269949+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-11T08:32:17.6269949+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "eb3fe3c2-9f29-4dc0-b104-720d81a524a9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "55e218be-3b31-4a1a-ae0a-ed16fd25d7b3",
      "Sequence": 1,
      "AncestorCategoryId": "3ac1e074-3a31-44ea-bb75-8a135e5cd922",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "eb3fe3c2-9f29-4dc0-b104-720d81a524a9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "55e218be-3b31-4a1a-ae0a-ed16fd25d7b3",
      "Sequence": 1,
      "AncestorCategoryId": "3ac1e074-3a31-44ea-bb75-8a135e5cd922",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "949d7e43-bd71-41c3-a5b1-988005b51c43",
          "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": "089d358d-a8b8-42b3-a295-dfe37db7d93d",
    "CategoryId": "0bfd4e11-3a0b-4ccd-b76e-52186eb8feb7",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "5dfa77f6-5cb2-4d1b-aa0d-59c33f2921ee",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "5dfa77f6-5cb2-4d1b-aa0d-59c33f2921ee",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7e29b4ba-ad19-4ea2-a64b-45eaa86d9750",
      "Questions": [
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        },
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7e29b4ba-ad19-4ea2-a64b-45eaa86d9750",
      "Questions": [
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        },
        {
          "Id": "3a85f238-26e5-41b7-b969-53fd03450493",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "c076eead-e9d3-4952-8bc3-0eb0525b6d2f",
      "ContentItemId": "587081c8-60a9-4f48-95d6-fbcc24a1c3b6",
      "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-11T08:32:17.6426214+00:00",
      "RescheduleDate": "2026-05-11T08:32:17.6426214+00:00"
    },
    {
      "Id": "c076eead-e9d3-4952-8bc3-0eb0525b6d2f",
      "ContentItemId": "587081c8-60a9-4f48-95d6-fbcc24a1c3b6",
      "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-11T08:32:17.6426214+00:00",
      "RescheduleDate": "2026-05-11T08:32:17.6426214+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}