GET v2/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.View.UserStateViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.
IsNewUser

boolean

None.
UserName

string

None.
PrivacyPolicyApprove

boolean

None.
ServerTime

date

None.
Registration

Collection of 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": "c44dde3f-339c-422d-96ff-356b7ba21b16",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-09-16T00:39:25.5728251+00:00",
  "Registration": [
    {
      "Id": "7eba1f22-11af-419d-befa-072914277616",
      "UserId": "27d3fd33-2505-4885-8e44-13bb4ee83707",
      "IsCurrent": true,
      "CenterId": "aadbba26-4f45-4578-b9f4-5a82abf26bfb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a49f9059-c85b-4ffb-b1f4-0f676f0825fd",
      "EndDate": "2025-09-16T00:39:25.5728251+00:00",
      "StartDate": "2025-09-16T00:39:25.5728251+00:00",
      "SchedulePreferenceDate": "2025-09-16T00:39:25.5728251+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"
    },
    {
      "Id": "7eba1f22-11af-419d-befa-072914277616",
      "UserId": "27d3fd33-2505-4885-8e44-13bb4ee83707",
      "IsCurrent": true,
      "CenterId": "aadbba26-4f45-4578-b9f4-5a82abf26bfb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a49f9059-c85b-4ffb-b1f4-0f676f0825fd",
      "EndDate": "2025-09-16T00:39:25.5728251+00:00",
      "StartDate": "2025-09-16T00:39:25.5728251+00:00",
      "SchedulePreferenceDate": "2025-09-16T00:39:25.5728251+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": "2025-09-16T00:39:25.5728251+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a51ece28-048c-4c1b-8369-f638e831922f",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a276fc3d-ba2f-4f7d-8581-83c6f066cd6e",
      "Sequence": 1,
      "AncestorCategoryId": "d8598ae5-7c6b-4036-b9cf-4a00d45b09e3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "a51ece28-048c-4c1b-8369-f638e831922f",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a276fc3d-ba2f-4f7d-8581-83c6f066cd6e",
      "Sequence": 1,
      "AncestorCategoryId": "d8598ae5-7c6b-4036-b9cf-4a00d45b09e3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "528eeb1c-ba53-44a5-8b60-ffcd7ca5a610",
    "CategoryId": "0f31ab53-fde4-49ca-a96a-5687999d20ee",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "70a86d44-d9aa-48e4-870d-930b2555f7d7",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "70a86d44-d9aa-48e4-870d-930b2555f7d7",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "bc86017a-df66-4f4c-986c-51b59cd989c1",
      "Questions": [
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        },
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "bc86017a-df66-4f4c-986c-51b59cd989c1",
      "Questions": [
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        },
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "dba37a86-c2d2-4375-b5c6-2290dafca820",
      "ContentItemId": "d36c782e-f8c9-4823-8ea5-aa6b0b439691",
      "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": "2025-09-16T00:39:25.5728251+00:00",
      "RescheduleDate": "2025-09-16T00:39:25.5728251+00:00"
    },
    {
      "Id": "dba37a86-c2d2-4375-b5c6-2290dafca820",
      "ContentItemId": "d36c782e-f8c9-4823-8ea5-aa6b0b439691",
      "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": "2025-09-16T00:39:25.5728251+00:00",
      "RescheduleDate": "2025-09-16T00:39:25.5728251+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "c44dde3f-339c-422d-96ff-356b7ba21b16",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-09-16T00:39:25.5884516+00:00",
  "Registration": [
    {
      "Id": "7eba1f22-11af-419d-befa-072914277616",
      "UserId": "27d3fd33-2505-4885-8e44-13bb4ee83707",
      "IsCurrent": true,
      "CenterId": "aadbba26-4f45-4578-b9f4-5a82abf26bfb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a49f9059-c85b-4ffb-b1f4-0f676f0825fd",
      "EndDate": "2025-09-16T00:39:25.5728251+00:00",
      "StartDate": "2025-09-16T00:39:25.5728251+00:00",
      "SchedulePreferenceDate": "2025-09-16T00:39:25.5728251+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"
    },
    {
      "Id": "7eba1f22-11af-419d-befa-072914277616",
      "UserId": "27d3fd33-2505-4885-8e44-13bb4ee83707",
      "IsCurrent": true,
      "CenterId": "aadbba26-4f45-4578-b9f4-5a82abf26bfb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a49f9059-c85b-4ffb-b1f4-0f676f0825fd",
      "EndDate": "2025-09-16T00:39:25.5728251+00:00",
      "StartDate": "2025-09-16T00:39:25.5728251+00:00",
      "SchedulePreferenceDate": "2025-09-16T00:39:25.5728251+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": "2025-09-16T00:39:25.5728251+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a51ece28-048c-4c1b-8369-f638e831922f",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a276fc3d-ba2f-4f7d-8581-83c6f066cd6e",
      "Sequence": 1,
      "AncestorCategoryId": "d8598ae5-7c6b-4036-b9cf-4a00d45b09e3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "a51ece28-048c-4c1b-8369-f638e831922f",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a276fc3d-ba2f-4f7d-8581-83c6f066cd6e",
      "Sequence": 1,
      "AncestorCategoryId": "d8598ae5-7c6b-4036-b9cf-4a00d45b09e3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "39c0aab0-894b-4b66-b8c1-3aba7bc73d2c",
          "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": "528eeb1c-ba53-44a5-8b60-ffcd7ca5a610",
    "CategoryId": "0f31ab53-fde4-49ca-a96a-5687999d20ee",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "70a86d44-d9aa-48e4-870d-930b2555f7d7",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "70a86d44-d9aa-48e4-870d-930b2555f7d7",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "bc86017a-df66-4f4c-986c-51b59cd989c1",
      "Questions": [
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        },
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "bc86017a-df66-4f4c-986c-51b59cd989c1",
      "Questions": [
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        },
        {
          "Id": "3455bbb3-7b2a-441a-839c-6c889f475d8a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "dba37a86-c2d2-4375-b5c6-2290dafca820",
      "ContentItemId": "d36c782e-f8c9-4823-8ea5-aa6b0b439691",
      "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": "2025-09-16T00:39:25.5728251+00:00",
      "RescheduleDate": "2025-09-16T00:39:25.5728251+00:00"
    },
    {
      "Id": "dba37a86-c2d2-4375-b5c6-2290dafca820",
      "ContentItemId": "d36c782e-f8c9-4823-8ea5-aa6b0b439691",
      "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": "2025-09-16T00:39:25.5728251+00:00",
      "RescheduleDate": "2025-09-16T00:39:25.5728251+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}