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": "7836c2f2-ccca-47cc-9f86-2463db3b024e",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-24T12:50:14.878917+00:00",
  "Registration": [
    {
      "Id": "6f536ca7-fca2-476f-b93a-8be98ac2d1c7",
      "UserId": "431105ea-336b-4ac5-9fb8-589090ffb530",
      "IsCurrent": true,
      "CenterId": "292e0100-4055-4707-8595-51991dc3a15c",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "aaf0a818-5785-4023-8115-cc29caafa93c",
      "EndDate": "2025-12-24T12:50:14.878917+00:00",
      "StartDate": "2025-12-24T12:50:14.878917+00:00",
      "SchedulePreferenceDate": "2025-12-24T12:50:14.878917+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": "6f536ca7-fca2-476f-b93a-8be98ac2d1c7",
      "UserId": "431105ea-336b-4ac5-9fb8-589090ffb530",
      "IsCurrent": true,
      "CenterId": "292e0100-4055-4707-8595-51991dc3a15c",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "aaf0a818-5785-4023-8115-cc29caafa93c",
      "EndDate": "2025-12-24T12:50:14.878917+00:00",
      "StartDate": "2025-12-24T12:50:14.878917+00:00",
      "SchedulePreferenceDate": "2025-12-24T12:50:14.878917+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-12-24T12:50:14.878917+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "ae022145-d6af-49f1-af96-5021634e5c58",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8e5321a4-8e54-4017-a49d-107289265014",
      "Sequence": 1,
      "AncestorCategoryId": "93f8f942-3e69-447b-b946-4d0cbb027f6a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "ae022145-d6af-49f1-af96-5021634e5c58",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8e5321a4-8e54-4017-a49d-107289265014",
      "Sequence": 1,
      "AncestorCategoryId": "93f8f942-3e69-447b-b946-4d0cbb027f6a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "01127215-d788-4dd8-977f-11ff375cb0c4",
    "CategoryId": "3476f41e-91bc-44d9-8ada-312be11bfe7f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "67ac0cf4-fa72-45ed-90df-7c19ee944aaa",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "67ac0cf4-fa72-45ed-90df-7c19ee944aaa",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "439c8e82-352f-4bad-a95a-2d306abef10d",
      "Questions": [
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        },
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "439c8e82-352f-4bad-a95a-2d306abef10d",
      "Questions": [
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        },
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "4d783500-5015-4422-b2ba-9b5cb4a0c821",
      "ContentItemId": "22bc1319-30ef-4d7d-9084-0dfb1842ed6f",
      "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-12-24T12:50:14.878917+00:00",
      "RescheduleDate": "2025-12-24T12:50:14.878917+00:00"
    },
    {
      "Id": "4d783500-5015-4422-b2ba-9b5cb4a0c821",
      "ContentItemId": "22bc1319-30ef-4d7d-9084-0dfb1842ed6f",
      "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-12-24T12:50:14.878917+00:00",
      "RescheduleDate": "2025-12-24T12:50:14.878917+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": "7836c2f2-ccca-47cc-9f86-2463db3b024e",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-24T12:50:14.9257948+00:00",
  "Registration": [
    {
      "Id": "6f536ca7-fca2-476f-b93a-8be98ac2d1c7",
      "UserId": "431105ea-336b-4ac5-9fb8-589090ffb530",
      "IsCurrent": true,
      "CenterId": "292e0100-4055-4707-8595-51991dc3a15c",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "aaf0a818-5785-4023-8115-cc29caafa93c",
      "EndDate": "2025-12-24T12:50:14.878917+00:00",
      "StartDate": "2025-12-24T12:50:14.878917+00:00",
      "SchedulePreferenceDate": "2025-12-24T12:50:14.878917+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": "6f536ca7-fca2-476f-b93a-8be98ac2d1c7",
      "UserId": "431105ea-336b-4ac5-9fb8-589090ffb530",
      "IsCurrent": true,
      "CenterId": "292e0100-4055-4707-8595-51991dc3a15c",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "aaf0a818-5785-4023-8115-cc29caafa93c",
      "EndDate": "2025-12-24T12:50:14.878917+00:00",
      "StartDate": "2025-12-24T12:50:14.878917+00:00",
      "SchedulePreferenceDate": "2025-12-24T12:50:14.878917+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-12-24T12:50:14.878917+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "ae022145-d6af-49f1-af96-5021634e5c58",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8e5321a4-8e54-4017-a49d-107289265014",
      "Sequence": 1,
      "AncestorCategoryId": "93f8f942-3e69-447b-b946-4d0cbb027f6a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "ae022145-d6af-49f1-af96-5021634e5c58",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8e5321a4-8e54-4017-a49d-107289265014",
      "Sequence": 1,
      "AncestorCategoryId": "93f8f942-3e69-447b-b946-4d0cbb027f6a",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "96778b01-fc2b-4cb2-8ae3-8e80a4edb02e",
          "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": "01127215-d788-4dd8-977f-11ff375cb0c4",
    "CategoryId": "3476f41e-91bc-44d9-8ada-312be11bfe7f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "67ac0cf4-fa72-45ed-90df-7c19ee944aaa",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "67ac0cf4-fa72-45ed-90df-7c19ee944aaa",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "439c8e82-352f-4bad-a95a-2d306abef10d",
      "Questions": [
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        },
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "439c8e82-352f-4bad-a95a-2d306abef10d",
      "Questions": [
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        },
        {
          "Id": "6cbc24c3-8fab-450d-8ae6-ef8c5d9a91cd",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "4d783500-5015-4422-b2ba-9b5cb4a0c821",
      "ContentItemId": "22bc1319-30ef-4d7d-9084-0dfb1842ed6f",
      "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-12-24T12:50:14.878917+00:00",
      "RescheduleDate": "2025-12-24T12:50:14.878917+00:00"
    },
    {
      "Id": "4d783500-5015-4422-b2ba-9b5cb4a0c821",
      "ContentItemId": "22bc1319-30ef-4d7d-9084-0dfb1842ed6f",
      "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-12-24T12:50:14.878917+00:00",
      "RescheduleDate": "2025-12-24T12:50:14.878917+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}