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": "61e31700-3687-4d00-839c-7def6652bf9b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-21T17:57:43.8086601+00:00",
  "Registration": [
    {
      "Id": "729da689-89f8-46c5-b159-a243d1bff3d4",
      "UserId": "0f4304bc-ef85-49e9-8b79-1b70e01a75f6",
      "IsCurrent": true,
      "CenterId": "f694a69a-64e0-475a-9a49-100f0da5a9b1",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "655ee729-1493-4278-b33f-00197fb3ab5b",
      "EndDate": "2025-11-21T17:57:43.8086601+00:00",
      "StartDate": "2025-11-21T17:57:43.8086601+00:00",
      "SchedulePreferenceDate": "2025-11-21T17:57:43.8086601+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": "729da689-89f8-46c5-b159-a243d1bff3d4",
      "UserId": "0f4304bc-ef85-49e9-8b79-1b70e01a75f6",
      "IsCurrent": true,
      "CenterId": "f694a69a-64e0-475a-9a49-100f0da5a9b1",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "655ee729-1493-4278-b33f-00197fb3ab5b",
      "EndDate": "2025-11-21T17:57:43.8086601+00:00",
      "StartDate": "2025-11-21T17:57:43.8086601+00:00",
      "SchedulePreferenceDate": "2025-11-21T17:57:43.8086601+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-21T17:57:43.8086601+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "0fabc0ed-1c6c-4d2c-9b3c-bac8ebadbdd5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "055eed97-dab4-497a-ba5d-9ea815cb7178",
      "Sequence": 1,
      "AncestorCategoryId": "55eb61fa-2784-47ff-8609-1a8a1b6f82df",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "0fabc0ed-1c6c-4d2c-9b3c-bac8ebadbdd5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "055eed97-dab4-497a-ba5d-9ea815cb7178",
      "Sequence": 1,
      "AncestorCategoryId": "55eb61fa-2784-47ff-8609-1a8a1b6f82df",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "3f4155dc-5275-4c89-a294-fa625cb72258",
    "CategoryId": "e341b541-46c7-445a-a2c7-ce90e8d89550",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2c87bba7-2b1e-4901-b418-cc8eed8eca99",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2c87bba7-2b1e-4901-b418-cc8eed8eca99",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "fb4ff3f4-85f2-489b-a3e8-5471b7612f2b",
      "Questions": [
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        },
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "fb4ff3f4-85f2-489b-a3e8-5471b7612f2b",
      "Questions": [
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        },
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "eb142a5d-e1eb-4a15-bd9b-89f22f938cc1",
      "ContentItemId": "39dc6890-7f2a-4fe4-9441-04c9f9227383",
      "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-21T17:57:43.8086601+00:00",
      "RescheduleDate": "2025-11-21T17:57:43.8086601+00:00"
    },
    {
      "Id": "eb142a5d-e1eb-4a15-bd9b-89f22f938cc1",
      "ContentItemId": "39dc6890-7f2a-4fe4-9441-04c9f9227383",
      "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-21T17:57:43.8086601+00:00",
      "RescheduleDate": "2025-11-21T17:57:43.8086601+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": "61e31700-3687-4d00-839c-7def6652bf9b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-21T17:57:43.8399131+00:00",
  "Registration": [
    {
      "Id": "729da689-89f8-46c5-b159-a243d1bff3d4",
      "UserId": "0f4304bc-ef85-49e9-8b79-1b70e01a75f6",
      "IsCurrent": true,
      "CenterId": "f694a69a-64e0-475a-9a49-100f0da5a9b1",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "655ee729-1493-4278-b33f-00197fb3ab5b",
      "EndDate": "2025-11-21T17:57:43.8086601+00:00",
      "StartDate": "2025-11-21T17:57:43.8086601+00:00",
      "SchedulePreferenceDate": "2025-11-21T17:57:43.8086601+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": "729da689-89f8-46c5-b159-a243d1bff3d4",
      "UserId": "0f4304bc-ef85-49e9-8b79-1b70e01a75f6",
      "IsCurrent": true,
      "CenterId": "f694a69a-64e0-475a-9a49-100f0da5a9b1",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "655ee729-1493-4278-b33f-00197fb3ab5b",
      "EndDate": "2025-11-21T17:57:43.8086601+00:00",
      "StartDate": "2025-11-21T17:57:43.8086601+00:00",
      "SchedulePreferenceDate": "2025-11-21T17:57:43.8086601+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-21T17:57:43.8086601+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "0fabc0ed-1c6c-4d2c-9b3c-bac8ebadbdd5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "055eed97-dab4-497a-ba5d-9ea815cb7178",
      "Sequence": 1,
      "AncestorCategoryId": "55eb61fa-2784-47ff-8609-1a8a1b6f82df",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "0fabc0ed-1c6c-4d2c-9b3c-bac8ebadbdd5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "055eed97-dab4-497a-ba5d-9ea815cb7178",
      "Sequence": 1,
      "AncestorCategoryId": "55eb61fa-2784-47ff-8609-1a8a1b6f82df",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "a1119a7f-9cfb-41ff-8c0c-d3a3c78e8b79",
          "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": "3f4155dc-5275-4c89-a294-fa625cb72258",
    "CategoryId": "e341b541-46c7-445a-a2c7-ce90e8d89550",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2c87bba7-2b1e-4901-b418-cc8eed8eca99",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2c87bba7-2b1e-4901-b418-cc8eed8eca99",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "fb4ff3f4-85f2-489b-a3e8-5471b7612f2b",
      "Questions": [
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        },
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "fb4ff3f4-85f2-489b-a3e8-5471b7612f2b",
      "Questions": [
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        },
        {
          "Id": "a92c5ed4-426b-4124-9397-f8ace73c0412",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "eb142a5d-e1eb-4a15-bd9b-89f22f938cc1",
      "ContentItemId": "39dc6890-7f2a-4fe4-9441-04c9f9227383",
      "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-21T17:57:43.8086601+00:00",
      "RescheduleDate": "2025-11-21T17:57:43.8086601+00:00"
    },
    {
      "Id": "eb142a5d-e1eb-4a15-bd9b-89f22f938cc1",
      "ContentItemId": "39dc6890-7f2a-4fe4-9441-04c9f9227383",
      "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-21T17:57:43.8086601+00:00",
      "RescheduleDate": "2025-11-21T17:57:43.8086601+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}