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": "7d56bb6c-5662-4aea-8648-eb367a85aa12",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-25T22:52:33.860978+00:00",
  "Registration": [
    {
      "Id": "5e5b199e-34b1-4455-9838-40537f243d94",
      "UserId": "8fb16b1d-40ef-416c-8657-2883404a3b2d",
      "IsCurrent": true,
      "CenterId": "22e4e323-443d-43bf-9d07-0a7f2cde1e8a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "edaf1289-3a81-411e-8ae4-d6a4d1ca0f79",
      "EndDate": "2025-12-25T22:52:33.8453667+00:00",
      "StartDate": "2025-12-25T22:52:33.8453667+00:00",
      "SchedulePreferenceDate": "2025-12-25T22:52:33.8453667+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": "5e5b199e-34b1-4455-9838-40537f243d94",
      "UserId": "8fb16b1d-40ef-416c-8657-2883404a3b2d",
      "IsCurrent": true,
      "CenterId": "22e4e323-443d-43bf-9d07-0a7f2cde1e8a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "edaf1289-3a81-411e-8ae4-d6a4d1ca0f79",
      "EndDate": "2025-12-25T22:52:33.8453667+00:00",
      "StartDate": "2025-12-25T22:52:33.8453667+00:00",
      "SchedulePreferenceDate": "2025-12-25T22:52:33.8453667+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-25T22:52:33.8453667+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "01860208-9076-4b27-b981-c27b636f0940",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "48a05b09-1f2e-40d5-b697-09bf68c002a0",
      "Sequence": 1,
      "AncestorCategoryId": "128144f9-affd-4bed-b7fd-7812dbcfbd20",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "01860208-9076-4b27-b981-c27b636f0940",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "48a05b09-1f2e-40d5-b697-09bf68c002a0",
      "Sequence": 1,
      "AncestorCategoryId": "128144f9-affd-4bed-b7fd-7812dbcfbd20",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "883801d7-48fe-4d15-b7e9-cdd0c9119972",
    "CategoryId": "738b1101-c773-4458-95bc-c789ad9976b6",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "41b1883e-a16b-4c59-bd58-de4ae6eb8770",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "41b1883e-a16b-4c59-bd58-de4ae6eb8770",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d6d1ef4e-0737-432e-9e3f-580b679852d4",
      "Questions": [
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d6d1ef4e-0737-432e-9e3f-580b679852d4",
      "Questions": [
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "9f9cccc9-de2a-41d1-86b7-0615ef1f2b2f",
      "ContentItemId": "67d5fb3c-684d-4337-a6b4-9dede43293ee",
      "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-25T22:52:33.8453667+00:00",
      "RescheduleDate": "2025-12-25T22:52:33.8453667+00:00"
    },
    {
      "Id": "9f9cccc9-de2a-41d1-86b7-0615ef1f2b2f",
      "ContentItemId": "67d5fb3c-684d-4337-a6b4-9dede43293ee",
      "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-25T22:52:33.8453667+00:00",
      "RescheduleDate": "2025-12-25T22:52:33.8453667+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": "7d56bb6c-5662-4aea-8648-eb367a85aa12",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-25T22:52:33.9390432+00:00",
  "Registration": [
    {
      "Id": "5e5b199e-34b1-4455-9838-40537f243d94",
      "UserId": "8fb16b1d-40ef-416c-8657-2883404a3b2d",
      "IsCurrent": true,
      "CenterId": "22e4e323-443d-43bf-9d07-0a7f2cde1e8a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "edaf1289-3a81-411e-8ae4-d6a4d1ca0f79",
      "EndDate": "2025-12-25T22:52:33.8453667+00:00",
      "StartDate": "2025-12-25T22:52:33.8453667+00:00",
      "SchedulePreferenceDate": "2025-12-25T22:52:33.8453667+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": "5e5b199e-34b1-4455-9838-40537f243d94",
      "UserId": "8fb16b1d-40ef-416c-8657-2883404a3b2d",
      "IsCurrent": true,
      "CenterId": "22e4e323-443d-43bf-9d07-0a7f2cde1e8a",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "edaf1289-3a81-411e-8ae4-d6a4d1ca0f79",
      "EndDate": "2025-12-25T22:52:33.8453667+00:00",
      "StartDate": "2025-12-25T22:52:33.8453667+00:00",
      "SchedulePreferenceDate": "2025-12-25T22:52:33.8453667+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-25T22:52:33.8453667+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "01860208-9076-4b27-b981-c27b636f0940",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "48a05b09-1f2e-40d5-b697-09bf68c002a0",
      "Sequence": 1,
      "AncestorCategoryId": "128144f9-affd-4bed-b7fd-7812dbcfbd20",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "01860208-9076-4b27-b981-c27b636f0940",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "48a05b09-1f2e-40d5-b697-09bf68c002a0",
      "Sequence": 1,
      "AncestorCategoryId": "128144f9-affd-4bed-b7fd-7812dbcfbd20",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "c8eb401d-bce3-453c-adad-00d742c64f92",
          "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": "883801d7-48fe-4d15-b7e9-cdd0c9119972",
    "CategoryId": "738b1101-c773-4458-95bc-c789ad9976b6",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "41b1883e-a16b-4c59-bd58-de4ae6eb8770",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "41b1883e-a16b-4c59-bd58-de4ae6eb8770",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d6d1ef4e-0737-432e-9e3f-580b679852d4",
      "Questions": [
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d6d1ef4e-0737-432e-9e3f-580b679852d4",
      "Questions": [
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        },
        {
          "Id": "c8cb1fd3-619a-4118-a7a5-a103efc6450a",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "9f9cccc9-de2a-41d1-86b7-0615ef1f2b2f",
      "ContentItemId": "67d5fb3c-684d-4337-a6b4-9dede43293ee",
      "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-25T22:52:33.8453667+00:00",
      "RescheduleDate": "2025-12-25T22:52:33.8453667+00:00"
    },
    {
      "Id": "9f9cccc9-de2a-41d1-86b7-0615ef1f2b2f",
      "ContentItemId": "67d5fb3c-684d-4337-a6b4-9dede43293ee",
      "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-25T22:52:33.8453667+00:00",
      "RescheduleDate": "2025-12-25T22:52:33.8453667+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}