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": "243fd39c-d440-424c-a766-7abe5a345e07",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-09-11T20:45:01.3652074+00:00",
  "Registration": [
    {
      "Id": "26a5b128-64ab-4840-803b-57fdf1fee31a",
      "UserId": "50401e15-3ba5-47b7-a28d-bd50ce931d7a",
      "IsCurrent": true,
      "CenterId": "18be6ede-882d-4551-839d-07fbc8441585",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f575b7cd-98ed-4c07-b5be-39fd1e41e3fb",
      "EndDate": "2025-09-11T20:45:01.3652074+00:00",
      "StartDate": "2025-09-11T20:45:01.3652074+00:00",
      "SchedulePreferenceDate": "2025-09-11T20:45:01.3652074+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": "26a5b128-64ab-4840-803b-57fdf1fee31a",
      "UserId": "50401e15-3ba5-47b7-a28d-bd50ce931d7a",
      "IsCurrent": true,
      "CenterId": "18be6ede-882d-4551-839d-07fbc8441585",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f575b7cd-98ed-4c07-b5be-39fd1e41e3fb",
      "EndDate": "2025-09-11T20:45:01.3652074+00:00",
      "StartDate": "2025-09-11T20:45:01.3652074+00:00",
      "SchedulePreferenceDate": "2025-09-11T20:45:01.3652074+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-09-11T20:45:01.3652074+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f20ae297-9d36-428c-88d0-0f5024183d84",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a72017dc-4649-4aa3-a66f-118bafd0a0e6",
      "Sequence": 1,
      "AncestorCategoryId": "8868308c-d3c5-41f8-b908-afe368914cbe",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "f20ae297-9d36-428c-88d0-0f5024183d84",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a72017dc-4649-4aa3-a66f-118bafd0a0e6",
      "Sequence": 1,
      "AncestorCategoryId": "8868308c-d3c5-41f8-b908-afe368914cbe",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "cadd0321-57b6-4c99-927a-e799b4e82d20",
    "CategoryId": "1abbcd20-3c8a-4df3-a9cf-6bb377a908aa",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "724d016f-5196-4b8c-8e79-12a2edf57d96",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "724d016f-5196-4b8c-8e79-12a2edf57d96",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4f08fb0e-03b6-4138-a260-3b56bd772cac",
      "Questions": [
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        },
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4f08fb0e-03b6-4138-a260-3b56bd772cac",
      "Questions": [
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        },
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "23a493f3-6adc-4e73-81d6-1504c9ba2235",
      "ContentItemId": "e9aa3590-1d13-4646-8840-4f02868c1f22",
      "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-09-11T20:45:01.3652074+00:00",
      "RescheduleDate": "2025-09-11T20:45:01.3652074+00:00"
    },
    {
      "Id": "23a493f3-6adc-4e73-81d6-1504c9ba2235",
      "ContentItemId": "e9aa3590-1d13-4646-8840-4f02868c1f22",
      "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-09-11T20:45:01.3652074+00:00",
      "RescheduleDate": "2025-09-11T20:45:01.3652074+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "243fd39c-d440-424c-a766-7abe5a345e07",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-09-11T20:45:01.4589619+00:00",
  "Registration": [
    {
      "Id": "26a5b128-64ab-4840-803b-57fdf1fee31a",
      "UserId": "50401e15-3ba5-47b7-a28d-bd50ce931d7a",
      "IsCurrent": true,
      "CenterId": "18be6ede-882d-4551-839d-07fbc8441585",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f575b7cd-98ed-4c07-b5be-39fd1e41e3fb",
      "EndDate": "2025-09-11T20:45:01.3652074+00:00",
      "StartDate": "2025-09-11T20:45:01.3652074+00:00",
      "SchedulePreferenceDate": "2025-09-11T20:45:01.3652074+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": "26a5b128-64ab-4840-803b-57fdf1fee31a",
      "UserId": "50401e15-3ba5-47b7-a28d-bd50ce931d7a",
      "IsCurrent": true,
      "CenterId": "18be6ede-882d-4551-839d-07fbc8441585",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f575b7cd-98ed-4c07-b5be-39fd1e41e3fb",
      "EndDate": "2025-09-11T20:45:01.3652074+00:00",
      "StartDate": "2025-09-11T20:45:01.3652074+00:00",
      "SchedulePreferenceDate": "2025-09-11T20:45:01.3652074+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-09-11T20:45:01.3652074+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f20ae297-9d36-428c-88d0-0f5024183d84",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a72017dc-4649-4aa3-a66f-118bafd0a0e6",
      "Sequence": 1,
      "AncestorCategoryId": "8868308c-d3c5-41f8-b908-afe368914cbe",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "f20ae297-9d36-428c-88d0-0f5024183d84",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a72017dc-4649-4aa3-a66f-118bafd0a0e6",
      "Sequence": 1,
      "AncestorCategoryId": "8868308c-d3c5-41f8-b908-afe368914cbe",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "94cb762a-ad40-4af9-b28c-35ad413305e5",
          "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": "cadd0321-57b6-4c99-927a-e799b4e82d20",
    "CategoryId": "1abbcd20-3c8a-4df3-a9cf-6bb377a908aa",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "724d016f-5196-4b8c-8e79-12a2edf57d96",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "724d016f-5196-4b8c-8e79-12a2edf57d96",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4f08fb0e-03b6-4138-a260-3b56bd772cac",
      "Questions": [
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        },
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4f08fb0e-03b6-4138-a260-3b56bd772cac",
      "Questions": [
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        },
        {
          "Id": "b3a33a32-a457-4430-81db-0f3699cbe589",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "23a493f3-6adc-4e73-81d6-1504c9ba2235",
      "ContentItemId": "e9aa3590-1d13-4646-8840-4f02868c1f22",
      "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-09-11T20:45:01.3652074+00:00",
      "RescheduleDate": "2025-09-11T20:45:01.3652074+00:00"
    },
    {
      "Id": "23a493f3-6adc-4e73-81d6-1504c9ba2235",
      "ContentItemId": "e9aa3590-1d13-4646-8840-4f02868c1f22",
      "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-09-11T20:45:01.3652074+00:00",
      "RescheduleDate": "2025-09-11T20:45:01.3652074+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}