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.
StudentSpeakPlusLevelInfo

string

None.

Response Formats

application/json

Sample: 
{
  "UserId": "03c9de8e-63f7-4873-b4bc-2ed9c14a7e25",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-20T01:31:11.6174918+00:00",
  "Registration": [
    {
      "Id": "c87328e1-6d6e-427a-8d40-5ec9f5e76838",
      "UserId": "91f0b13e-ec2f-4c71-bab4-f950bec58193",
      "IsCurrent": true,
      "CenterId": "544710dc-0686-49e9-9198-03b4aa39826f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e400e2ef-14f0-48be-ac0a-b6b2e20c34d0",
      "EndDate": "2025-11-20T01:31:11.6018677+00:00",
      "StartDate": "2025-11-20T01:31:11.6018677+00:00",
      "SchedulePreferenceDate": "2025-11-20T01:31:11.6018677+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": "c87328e1-6d6e-427a-8d40-5ec9f5e76838",
      "UserId": "91f0b13e-ec2f-4c71-bab4-f950bec58193",
      "IsCurrent": true,
      "CenterId": "544710dc-0686-49e9-9198-03b4aa39826f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e400e2ef-14f0-48be-ac0a-b6b2e20c34d0",
      "EndDate": "2025-11-20T01:31:11.6018677+00:00",
      "StartDate": "2025-11-20T01:31:11.6018677+00:00",
      "SchedulePreferenceDate": "2025-11-20T01:31:11.6018677+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-11-20T01:31:11.6018677+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "25b31722-c547-4bd7-bf10-72bded476cfb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a8226f92-c6ee-4f04-aec1-e2676001690f",
      "Sequence": 1,
      "AncestorCategoryId": "c5dbab4e-e376-4bb9-8657-8efd04c9581f",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "25b31722-c547-4bd7-bf10-72bded476cfb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a8226f92-c6ee-4f04-aec1-e2676001690f",
      "Sequence": 1,
      "AncestorCategoryId": "c5dbab4e-e376-4bb9-8657-8efd04c9581f",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "c908de94-e37a-4a1b-aa59-e19d309871b5",
    "CategoryId": "c6245297-09ed-4661-b9bf-3aa25c918c71",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "52d799df-2848-4e4d-9ee7-eafac6ad0d03",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "52d799df-2848-4e4d-9ee7-eafac6ad0d03",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c20b9aff-a618-417c-ade9-2091eb5b0c81",
      "Questions": [
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        },
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c20b9aff-a618-417c-ade9-2091eb5b0c81",
      "Questions": [
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        },
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "f1163b9c-82c0-4889-8878-84b355a74ecc",
      "ContentItemId": "890a871e-15de-4484-a0bc-e4e34b7a62bf",
      "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-11-20T01:31:11.6018677+00:00",
      "RescheduleDate": "2025-11-20T01:31:11.6018677+00:00"
    },
    {
      "Id": "f1163b9c-82c0-4889-8878-84b355a74ecc",
      "ContentItemId": "890a871e-15de-4484-a0bc-e4e34b7a62bf",
      "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-11-20T01:31:11.6018677+00:00",
      "RescheduleDate": "2025-11-20T01:31:11.6018677+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}

text/json

Sample: 
{
  "UserId": "03c9de8e-63f7-4873-b4bc-2ed9c14a7e25",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-20T01:31:11.6487563+00:00",
  "Registration": [
    {
      "Id": "c87328e1-6d6e-427a-8d40-5ec9f5e76838",
      "UserId": "91f0b13e-ec2f-4c71-bab4-f950bec58193",
      "IsCurrent": true,
      "CenterId": "544710dc-0686-49e9-9198-03b4aa39826f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e400e2ef-14f0-48be-ac0a-b6b2e20c34d0",
      "EndDate": "2025-11-20T01:31:11.6018677+00:00",
      "StartDate": "2025-11-20T01:31:11.6018677+00:00",
      "SchedulePreferenceDate": "2025-11-20T01:31:11.6018677+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": "c87328e1-6d6e-427a-8d40-5ec9f5e76838",
      "UserId": "91f0b13e-ec2f-4c71-bab4-f950bec58193",
      "IsCurrent": true,
      "CenterId": "544710dc-0686-49e9-9198-03b4aa39826f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e400e2ef-14f0-48be-ac0a-b6b2e20c34d0",
      "EndDate": "2025-11-20T01:31:11.6018677+00:00",
      "StartDate": "2025-11-20T01:31:11.6018677+00:00",
      "SchedulePreferenceDate": "2025-11-20T01:31:11.6018677+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-11-20T01:31:11.6018677+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "25b31722-c547-4bd7-bf10-72bded476cfb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a8226f92-c6ee-4f04-aec1-e2676001690f",
      "Sequence": 1,
      "AncestorCategoryId": "c5dbab4e-e376-4bb9-8657-8efd04c9581f",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "25b31722-c547-4bd7-bf10-72bded476cfb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a8226f92-c6ee-4f04-aec1-e2676001690f",
      "Sequence": 1,
      "AncestorCategoryId": "c5dbab4e-e376-4bb9-8657-8efd04c9581f",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "2e91d1be-d311-4d1b-8111-086056195d2c",
          "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": "c908de94-e37a-4a1b-aa59-e19d309871b5",
    "CategoryId": "c6245297-09ed-4661-b9bf-3aa25c918c71",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "52d799df-2848-4e4d-9ee7-eafac6ad0d03",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "52d799df-2848-4e4d-9ee7-eafac6ad0d03",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c20b9aff-a618-417c-ade9-2091eb5b0c81",
      "Questions": [
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        },
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c20b9aff-a618-417c-ade9-2091eb5b0c81",
      "Questions": [
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        },
        {
          "Id": "715a386a-3ebf-4351-b7b2-59f3a8dbccc1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "f1163b9c-82c0-4889-8878-84b355a74ecc",
      "ContentItemId": "890a871e-15de-4484-a0bc-e4e34b7a62bf",
      "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-11-20T01:31:11.6018677+00:00",
      "RescheduleDate": "2025-11-20T01:31:11.6018677+00:00"
    },
    {
      "Id": "f1163b9c-82c0-4889-8878-84b355a74ecc",
      "ContentItemId": "890a871e-15de-4484-a0bc-e4e34b7a62bf",
      "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-11-20T01:31:11.6018677+00:00",
      "RescheduleDate": "2025-11-20T01:31:11.6018677+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}