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": "e98f9d8d-a7c2-4ccd-81b8-b98e018b1c05",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-06T22:41:59.6688885+00:00",
  "Registration": [
    {
      "Id": "a1a39445-d5d5-4ca4-a897-d9c123d811b8",
      "UserId": "e571b42d-0fe8-44ba-b028-ac2f53d337a7",
      "IsCurrent": true,
      "CenterId": "c76aefe0-3170-4600-8a8e-f0e8bf3fcb36",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "c441f8bd-92b8-4541-861e-8b86937e6830",
      "EndDate": "2025-12-06T22:41:59.6688885+00:00",
      "StartDate": "2025-12-06T22:41:59.6688885+00:00",
      "SchedulePreferenceDate": "2025-12-06T22:41:59.6688885+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": "a1a39445-d5d5-4ca4-a897-d9c123d811b8",
      "UserId": "e571b42d-0fe8-44ba-b028-ac2f53d337a7",
      "IsCurrent": true,
      "CenterId": "c76aefe0-3170-4600-8a8e-f0e8bf3fcb36",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "c441f8bd-92b8-4541-861e-8b86937e6830",
      "EndDate": "2025-12-06T22:41:59.6688885+00:00",
      "StartDate": "2025-12-06T22:41:59.6688885+00:00",
      "SchedulePreferenceDate": "2025-12-06T22:41:59.6688885+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-06T22:41:59.6688885+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c60ec4d7-c327-422f-91b4-9f6f0f2ae8f2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ef5f32ad-a0e9-43ad-9fe0-ecc123867c96",
      "Sequence": 1,
      "AncestorCategoryId": "1d0a4ec3-abf9-4219-a8f5-06c3a1560529",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "c60ec4d7-c327-422f-91b4-9f6f0f2ae8f2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ef5f32ad-a0e9-43ad-9fe0-ecc123867c96",
      "Sequence": 1,
      "AncestorCategoryId": "1d0a4ec3-abf9-4219-a8f5-06c3a1560529",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "4a33ac24-c60d-481e-aa35-6f578c5f7f3a",
    "CategoryId": "2fa72605-6c3a-48fb-8005-3a1acb5bb3f2",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1a468a06-3455-4e0c-a031-ca97965d3502",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1a468a06-3455-4e0c-a031-ca97965d3502",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d60934e2-38e9-42fe-90c7-e0f037609275",
      "Questions": [
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        },
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d60934e2-38e9-42fe-90c7-e0f037609275",
      "Questions": [
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        },
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "20bfc81e-77b1-4e75-8565-bdbf24abace1",
      "ContentItemId": "c5281f46-ec7f-4eca-bed4-76cbcc8cd503",
      "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-06T22:41:59.6688885+00:00",
      "RescheduleDate": "2025-12-06T22:41:59.6688885+00:00"
    },
    {
      "Id": "20bfc81e-77b1-4e75-8565-bdbf24abace1",
      "ContentItemId": "c5281f46-ec7f-4eca-bed4-76cbcc8cd503",
      "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-06T22:41:59.6688885+00:00",
      "RescheduleDate": "2025-12-06T22:41:59.6688885+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": "e98f9d8d-a7c2-4ccd-81b8-b98e018b1c05",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-12-06T22:41:59.7001815+00:00",
  "Registration": [
    {
      "Id": "a1a39445-d5d5-4ca4-a897-d9c123d811b8",
      "UserId": "e571b42d-0fe8-44ba-b028-ac2f53d337a7",
      "IsCurrent": true,
      "CenterId": "c76aefe0-3170-4600-8a8e-f0e8bf3fcb36",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "c441f8bd-92b8-4541-861e-8b86937e6830",
      "EndDate": "2025-12-06T22:41:59.6688885+00:00",
      "StartDate": "2025-12-06T22:41:59.6688885+00:00",
      "SchedulePreferenceDate": "2025-12-06T22:41:59.6688885+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": "a1a39445-d5d5-4ca4-a897-d9c123d811b8",
      "UserId": "e571b42d-0fe8-44ba-b028-ac2f53d337a7",
      "IsCurrent": true,
      "CenterId": "c76aefe0-3170-4600-8a8e-f0e8bf3fcb36",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "c441f8bd-92b8-4541-861e-8b86937e6830",
      "EndDate": "2025-12-06T22:41:59.6688885+00:00",
      "StartDate": "2025-12-06T22:41:59.6688885+00:00",
      "SchedulePreferenceDate": "2025-12-06T22:41:59.6688885+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-06T22:41:59.6688885+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c60ec4d7-c327-422f-91b4-9f6f0f2ae8f2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ef5f32ad-a0e9-43ad-9fe0-ecc123867c96",
      "Sequence": 1,
      "AncestorCategoryId": "1d0a4ec3-abf9-4219-a8f5-06c3a1560529",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "c60ec4d7-c327-422f-91b4-9f6f0f2ae8f2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ef5f32ad-a0e9-43ad-9fe0-ecc123867c96",
      "Sequence": 1,
      "AncestorCategoryId": "1d0a4ec3-abf9-4219-a8f5-06c3a1560529",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "25e3c6e7-8a18-4040-851b-a05ee91a336d",
          "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": "4a33ac24-c60d-481e-aa35-6f578c5f7f3a",
    "CategoryId": "2fa72605-6c3a-48fb-8005-3a1acb5bb3f2",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1a468a06-3455-4e0c-a031-ca97965d3502",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1a468a06-3455-4e0c-a031-ca97965d3502",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d60934e2-38e9-42fe-90c7-e0f037609275",
      "Questions": [
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        },
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d60934e2-38e9-42fe-90c7-e0f037609275",
      "Questions": [
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        },
        {
          "Id": "13fdfe09-3022-453b-8fff-20755fa7361b",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "20bfc81e-77b1-4e75-8565-bdbf24abace1",
      "ContentItemId": "c5281f46-ec7f-4eca-bed4-76cbcc8cd503",
      "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-06T22:41:59.6688885+00:00",
      "RescheduleDate": "2025-12-06T22:41:59.6688885+00:00"
    },
    {
      "Id": "20bfc81e-77b1-4e75-8565-bdbf24abace1",
      "ContentItemId": "c5281f46-ec7f-4eca-bed4-76cbcc8cd503",
      "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-06T22:41:59.6688885+00:00",
      "RescheduleDate": "2025-12-06T22:41:59.6688885+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}