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": "519e629e-c1e0-428f-9fec-1255c53b197c",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-20T11:14:10.7468656+00:00",
  "Registration": [
    {
      "Id": "1fc9e96e-6323-4c49-9e05-8f6cfccb3326",
      "UserId": "ec22b77a-acb5-42bc-9936-56aa4979a36b",
      "IsCurrent": true,
      "CenterId": "d8c99685-b75a-4a6a-b469-04a457211270",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "031a07e1-3f54-4ef6-8331-7a8f3c3f14d0",
      "EndDate": "2026-08-20T11:14:10.7468656+00:00",
      "StartDate": "2026-08-20T11:14:10.7468656+00:00",
      "SchedulePreferenceDate": "2026-08-20T11:14:10.7468656+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": "1fc9e96e-6323-4c49-9e05-8f6cfccb3326",
      "UserId": "ec22b77a-acb5-42bc-9936-56aa4979a36b",
      "IsCurrent": true,
      "CenterId": "d8c99685-b75a-4a6a-b469-04a457211270",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "031a07e1-3f54-4ef6-8331-7a8f3c3f14d0",
      "EndDate": "2026-08-20T11:14:10.7468656+00:00",
      "StartDate": "2026-08-20T11:14:10.7468656+00:00",
      "SchedulePreferenceDate": "2026-08-20T11:14:10.7468656+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": "2026-08-20T11:14:10.7468656+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c8ea0ee4-d41f-4815-87ed-602d06dd0bda",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e6133d22-4442-430c-8201-13a55d5c440c",
      "Sequence": 1,
      "AncestorCategoryId": "e522c837-b797-4518-8512-176d7f49b991",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "c8ea0ee4-d41f-4815-87ed-602d06dd0bda",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e6133d22-4442-430c-8201-13a55d5c440c",
      "Sequence": 1,
      "AncestorCategoryId": "e522c837-b797-4518-8512-176d7f49b991",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "23f78cbc-cc18-4ef8-9047-33570e8dbb23",
    "CategoryId": "76334c56-59ee-4589-8210-52d8eefe0453",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6731259a-5b6a-4a7c-8756-c9ca6123754c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6731259a-5b6a-4a7c-8756-c9ca6123754c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "730146c1-152b-4cbd-972c-9601a5521f8a",
      "Questions": [
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "730146c1-152b-4cbd-972c-9601a5521f8a",
      "Questions": [
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "6fad329f-19d8-4554-9512-42e42ea4d15f",
      "ContentItemId": "bb1fa9ad-e8b4-46fa-92e4-620cdd3a10f3",
      "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": "2026-08-20T11:14:10.7468656+00:00",
      "RescheduleDate": "2026-08-20T11:14:10.7468656+00:00"
    },
    {
      "Id": "6fad329f-19d8-4554-9512-42e42ea4d15f",
      "ContentItemId": "bb1fa9ad-e8b4-46fa-92e4-620cdd3a10f3",
      "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": "2026-08-20T11:14:10.7468656+00:00",
      "RescheduleDate": "2026-08-20T11:14:10.7468656+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": "519e629e-c1e0-428f-9fec-1255c53b197c",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-20T11:14:10.7781168+00:00",
  "Registration": [
    {
      "Id": "1fc9e96e-6323-4c49-9e05-8f6cfccb3326",
      "UserId": "ec22b77a-acb5-42bc-9936-56aa4979a36b",
      "IsCurrent": true,
      "CenterId": "d8c99685-b75a-4a6a-b469-04a457211270",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "031a07e1-3f54-4ef6-8331-7a8f3c3f14d0",
      "EndDate": "2026-08-20T11:14:10.7468656+00:00",
      "StartDate": "2026-08-20T11:14:10.7468656+00:00",
      "SchedulePreferenceDate": "2026-08-20T11:14:10.7468656+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": "1fc9e96e-6323-4c49-9e05-8f6cfccb3326",
      "UserId": "ec22b77a-acb5-42bc-9936-56aa4979a36b",
      "IsCurrent": true,
      "CenterId": "d8c99685-b75a-4a6a-b469-04a457211270",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "031a07e1-3f54-4ef6-8331-7a8f3c3f14d0",
      "EndDate": "2026-08-20T11:14:10.7468656+00:00",
      "StartDate": "2026-08-20T11:14:10.7468656+00:00",
      "SchedulePreferenceDate": "2026-08-20T11:14:10.7468656+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": "2026-08-20T11:14:10.7468656+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "c8ea0ee4-d41f-4815-87ed-602d06dd0bda",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e6133d22-4442-430c-8201-13a55d5c440c",
      "Sequence": 1,
      "AncestorCategoryId": "e522c837-b797-4518-8512-176d7f49b991",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "c8ea0ee4-d41f-4815-87ed-602d06dd0bda",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e6133d22-4442-430c-8201-13a55d5c440c",
      "Sequence": 1,
      "AncestorCategoryId": "e522c837-b797-4518-8512-176d7f49b991",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "da319578-70b2-48d8-bf8e-f35b314e519b",
          "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": "23f78cbc-cc18-4ef8-9047-33570e8dbb23",
    "CategoryId": "76334c56-59ee-4589-8210-52d8eefe0453",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6731259a-5b6a-4a7c-8756-c9ca6123754c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6731259a-5b6a-4a7c-8756-c9ca6123754c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "730146c1-152b-4cbd-972c-9601a5521f8a",
      "Questions": [
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "730146c1-152b-4cbd-972c-9601a5521f8a",
      "Questions": [
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        },
        {
          "Id": "515d03d3-43b3-4878-b03e-557ecedab1d2",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "6fad329f-19d8-4554-9512-42e42ea4d15f",
      "ContentItemId": "bb1fa9ad-e8b4-46fa-92e4-620cdd3a10f3",
      "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": "2026-08-20T11:14:10.7468656+00:00",
      "RescheduleDate": "2026-08-20T11:14:10.7468656+00:00"
    },
    {
      "Id": "6fad329f-19d8-4554-9512-42e42ea4d15f",
      "ContentItemId": "bb1fa9ad-e8b4-46fa-92e4-620cdd3a10f3",
      "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": "2026-08-20T11:14:10.7468656+00:00",
      "RescheduleDate": "2026-08-20T11:14:10.7468656+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}