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": "5cbd3f91-5401-4a30-bd15-230bd9f06401",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-01T06:23:26.5022909+00:00",
  "Registration": [
    {
      "Id": "cc2e2ce5-35b2-4b60-8c82-3c306d162c6c",
      "UserId": "2f03ba2f-fb84-46dc-9461-e85ed11b742c",
      "IsCurrent": true,
      "CenterId": "b212ad6f-4c9e-4c45-a6ce-f4b4556c5b5e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "683fd4e6-5ff2-4c00-b53c-4d26706811f7",
      "EndDate": "2025-07-01T06:23:26.5022909+00:00",
      "StartDate": "2025-07-01T06:23:26.5022909+00:00",
      "SchedulePreferenceDate": "2025-07-01T06:23:26.5022909+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": "cc2e2ce5-35b2-4b60-8c82-3c306d162c6c",
      "UserId": "2f03ba2f-fb84-46dc-9461-e85ed11b742c",
      "IsCurrent": true,
      "CenterId": "b212ad6f-4c9e-4c45-a6ce-f4b4556c5b5e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "683fd4e6-5ff2-4c00-b53c-4d26706811f7",
      "EndDate": "2025-07-01T06:23:26.5022909+00:00",
      "StartDate": "2025-07-01T06:23:26.5022909+00:00",
      "SchedulePreferenceDate": "2025-07-01T06:23:26.5022909+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-01T06:23:26.5022909+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e0289b8c-82db-44b5-a1a3-634fbd38cd10",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c66cdfe4-35c1-4bd4-a779-03065c9e86e5",
      "Sequence": 1,
      "AncestorCategoryId": "881e74af-ed96-4281-b15a-2158d742a6ef",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "e0289b8c-82db-44b5-a1a3-634fbd38cd10",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c66cdfe4-35c1-4bd4-a779-03065c9e86e5",
      "Sequence": 1,
      "AncestorCategoryId": "881e74af-ed96-4281-b15a-2158d742a6ef",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "9e136766-82cd-40b8-b340-dd56d698c34d",
    "CategoryId": "58aef2d2-b122-4902-82c1-6bca091fc528",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "d55eaf0e-b9b6-4f87-b89a-40c4ec337e5a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "d55eaf0e-b9b6-4f87-b89a-40c4ec337e5a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c9e91dc3-e340-4803-b94a-701d3dda5930",
      "Questions": [
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        },
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c9e91dc3-e340-4803-b94a-701d3dda5930",
      "Questions": [
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        },
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "78983c64-23fd-42a7-9877-86156770ba8b",
      "ContentItemId": "be13a52b-8cc1-41d7-9054-ab1a22dfd2bb",
      "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-01T06:23:26.5022909+00:00",
      "RescheduleDate": "2025-07-01T06:23:26.5022909+00:00"
    },
    {
      "Id": "78983c64-23fd-42a7-9877-86156770ba8b",
      "ContentItemId": "be13a52b-8cc1-41d7-9054-ab1a22dfd2bb",
      "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-01T06:23:26.5022909+00:00",
      "RescheduleDate": "2025-07-01T06:23:26.5022909+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "5cbd3f91-5401-4a30-bd15-230bd9f06401",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-07-01T06:23:26.5647912+00:00",
  "Registration": [
    {
      "Id": "cc2e2ce5-35b2-4b60-8c82-3c306d162c6c",
      "UserId": "2f03ba2f-fb84-46dc-9461-e85ed11b742c",
      "IsCurrent": true,
      "CenterId": "b212ad6f-4c9e-4c45-a6ce-f4b4556c5b5e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "683fd4e6-5ff2-4c00-b53c-4d26706811f7",
      "EndDate": "2025-07-01T06:23:26.5022909+00:00",
      "StartDate": "2025-07-01T06:23:26.5022909+00:00",
      "SchedulePreferenceDate": "2025-07-01T06:23:26.5022909+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": "cc2e2ce5-35b2-4b60-8c82-3c306d162c6c",
      "UserId": "2f03ba2f-fb84-46dc-9461-e85ed11b742c",
      "IsCurrent": true,
      "CenterId": "b212ad6f-4c9e-4c45-a6ce-f4b4556c5b5e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "683fd4e6-5ff2-4c00-b53c-4d26706811f7",
      "EndDate": "2025-07-01T06:23:26.5022909+00:00",
      "StartDate": "2025-07-01T06:23:26.5022909+00:00",
      "SchedulePreferenceDate": "2025-07-01T06:23:26.5022909+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-01T06:23:26.5022909+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e0289b8c-82db-44b5-a1a3-634fbd38cd10",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c66cdfe4-35c1-4bd4-a779-03065c9e86e5",
      "Sequence": 1,
      "AncestorCategoryId": "881e74af-ed96-4281-b15a-2158d742a6ef",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "e0289b8c-82db-44b5-a1a3-634fbd38cd10",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "c66cdfe4-35c1-4bd4-a779-03065c9e86e5",
      "Sequence": 1,
      "AncestorCategoryId": "881e74af-ed96-4281-b15a-2158d742a6ef",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "8a1f7804-454e-4539-a4b5-4b165fdc7ffc",
          "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": "9e136766-82cd-40b8-b340-dd56d698c34d",
    "CategoryId": "58aef2d2-b122-4902-82c1-6bca091fc528",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "d55eaf0e-b9b6-4f87-b89a-40c4ec337e5a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "d55eaf0e-b9b6-4f87-b89a-40c4ec337e5a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c9e91dc3-e340-4803-b94a-701d3dda5930",
      "Questions": [
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        },
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c9e91dc3-e340-4803-b94a-701d3dda5930",
      "Questions": [
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        },
        {
          "Id": "1eab9e7c-262e-4fb0-bcea-cb10e3ec02d1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "78983c64-23fd-42a7-9877-86156770ba8b",
      "ContentItemId": "be13a52b-8cc1-41d7-9054-ab1a22dfd2bb",
      "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-01T06:23:26.5022909+00:00",
      "RescheduleDate": "2025-07-01T06:23:26.5022909+00:00"
    },
    {
      "Id": "78983c64-23fd-42a7-9877-86156770ba8b",
      "ContentItemId": "be13a52b-8cc1-41d7-9054-ab1a22dfd2bb",
      "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-01T06:23:26.5022909+00:00",
      "RescheduleDate": "2025-07-01T06:23:26.5022909+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}