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": "563bdec4-3c3f-4e86-be72-ec04fbddad62",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-04T02:56:10.6429041+00:00",
  "Registration": [
    {
      "Id": "33e87e7c-e734-4f7c-85f6-4f64edc9400b",
      "UserId": "53fc63fd-c56e-4ac0-8b59-3122042016af",
      "IsCurrent": true,
      "CenterId": "c37ec329-b960-47df-a81c-67fe7025aa56",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "85e2c260-f1e8-4447-aa63-9cd46d2e5cd3",
      "EndDate": "2025-07-04T02:56:10.6429041+00:00",
      "StartDate": "2025-07-04T02:56:10.6429041+00:00",
      "SchedulePreferenceDate": "2025-07-04T02:56:10.6429041+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": "33e87e7c-e734-4f7c-85f6-4f64edc9400b",
      "UserId": "53fc63fd-c56e-4ac0-8b59-3122042016af",
      "IsCurrent": true,
      "CenterId": "c37ec329-b960-47df-a81c-67fe7025aa56",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "85e2c260-f1e8-4447-aa63-9cd46d2e5cd3",
      "EndDate": "2025-07-04T02:56:10.6429041+00:00",
      "StartDate": "2025-07-04T02:56:10.6429041+00:00",
      "SchedulePreferenceDate": "2025-07-04T02:56:10.6429041+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-07-04T02:56:10.6429041+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4a03bb5e-b4c1-46c0-9206-dc99d7adf5ad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a1847bce-8663-41b8-b04f-df60d21c39e5",
      "Sequence": 1,
      "AncestorCategoryId": "a4041773-fb73-44ce-a23c-38d8586f091d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "4a03bb5e-b4c1-46c0-9206-dc99d7adf5ad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a1847bce-8663-41b8-b04f-df60d21c39e5",
      "Sequence": 1,
      "AncestorCategoryId": "a4041773-fb73-44ce-a23c-38d8586f091d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "d9794a27-c009-49f4-9089-0d750b4dc577",
    "CategoryId": "efbe105e-0a75-49d6-a8f2-efd182550eab",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6e9d7b34-9d78-48ee-9edd-d4e8fbb22e98",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6e9d7b34-9d78-48ee-9edd-d4e8fbb22e98",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "8f26db55-70ea-4038-95da-d5ec9f9b1a28",
      "Questions": [
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        },
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "8f26db55-70ea-4038-95da-d5ec9f9b1a28",
      "Questions": [
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        },
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0dc6261c-f32c-4883-8ba4-d4ffec9d4cb0",
      "ContentItemId": "98978f5d-625e-4ab4-ba5a-644bf755ed61",
      "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-07-04T02:56:10.6429041+00:00",
      "RescheduleDate": "2025-07-04T02:56:10.6429041+00:00"
    },
    {
      "Id": "0dc6261c-f32c-4883-8ba4-d4ffec9d4cb0",
      "ContentItemId": "98978f5d-625e-4ab4-ba5a-644bf755ed61",
      "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-07-04T02:56:10.6429041+00:00",
      "RescheduleDate": "2025-07-04T02:56:10.6429041+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "563bdec4-3c3f-4e86-be72-ec04fbddad62",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-04T02:56:10.6897793+00:00",
  "Registration": [
    {
      "Id": "33e87e7c-e734-4f7c-85f6-4f64edc9400b",
      "UserId": "53fc63fd-c56e-4ac0-8b59-3122042016af",
      "IsCurrent": true,
      "CenterId": "c37ec329-b960-47df-a81c-67fe7025aa56",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "85e2c260-f1e8-4447-aa63-9cd46d2e5cd3",
      "EndDate": "2025-07-04T02:56:10.6429041+00:00",
      "StartDate": "2025-07-04T02:56:10.6429041+00:00",
      "SchedulePreferenceDate": "2025-07-04T02:56:10.6429041+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": "33e87e7c-e734-4f7c-85f6-4f64edc9400b",
      "UserId": "53fc63fd-c56e-4ac0-8b59-3122042016af",
      "IsCurrent": true,
      "CenterId": "c37ec329-b960-47df-a81c-67fe7025aa56",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "85e2c260-f1e8-4447-aa63-9cd46d2e5cd3",
      "EndDate": "2025-07-04T02:56:10.6429041+00:00",
      "StartDate": "2025-07-04T02:56:10.6429041+00:00",
      "SchedulePreferenceDate": "2025-07-04T02:56:10.6429041+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-07-04T02:56:10.6429041+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4a03bb5e-b4c1-46c0-9206-dc99d7adf5ad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a1847bce-8663-41b8-b04f-df60d21c39e5",
      "Sequence": 1,
      "AncestorCategoryId": "a4041773-fb73-44ce-a23c-38d8586f091d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "4a03bb5e-b4c1-46c0-9206-dc99d7adf5ad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a1847bce-8663-41b8-b04f-df60d21c39e5",
      "Sequence": 1,
      "AncestorCategoryId": "a4041773-fb73-44ce-a23c-38d8586f091d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "77d14075-578d-4ffb-a732-3c6604514564",
          "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": "d9794a27-c009-49f4-9089-0d750b4dc577",
    "CategoryId": "efbe105e-0a75-49d6-a8f2-efd182550eab",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6e9d7b34-9d78-48ee-9edd-d4e8fbb22e98",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6e9d7b34-9d78-48ee-9edd-d4e8fbb22e98",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "8f26db55-70ea-4038-95da-d5ec9f9b1a28",
      "Questions": [
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        },
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "8f26db55-70ea-4038-95da-d5ec9f9b1a28",
      "Questions": [
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        },
        {
          "Id": "f1a101a3-9642-4598-8690-bb584b8fffed",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0dc6261c-f32c-4883-8ba4-d4ffec9d4cb0",
      "ContentItemId": "98978f5d-625e-4ab4-ba5a-644bf755ed61",
      "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-07-04T02:56:10.6429041+00:00",
      "RescheduleDate": "2025-07-04T02:56:10.6429041+00:00"
    },
    {
      "Id": "0dc6261c-f32c-4883-8ba4-d4ffec9d4cb0",
      "ContentItemId": "98978f5d-625e-4ab4-ba5a-644bf755ed61",
      "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-07-04T02:56:10.6429041+00:00",
      "RescheduleDate": "2025-07-04T02:56:10.6429041+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}