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": "e3d5d64e-bace-4558-80d3-4aebda9bf341",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-04T07:06:36.6248568+00:00",
  "Registration": [
    {
      "Id": "19d5ff84-0d16-441f-93a6-6947812a1dbe",
      "UserId": "060987f1-7e87-4e70-a2e5-36f675533599",
      "IsCurrent": true,
      "CenterId": "eb766bd2-fcb5-4f1b-ab59-d1387e24dafb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a4143b82-99ad-41ae-8804-87cc0717e3b9",
      "EndDate": "2026-03-04T07:06:36.6248568+00:00",
      "StartDate": "2026-03-04T07:06:36.6248568+00:00",
      "SchedulePreferenceDate": "2026-03-04T07:06:36.6248568+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": "19d5ff84-0d16-441f-93a6-6947812a1dbe",
      "UserId": "060987f1-7e87-4e70-a2e5-36f675533599",
      "IsCurrent": true,
      "CenterId": "eb766bd2-fcb5-4f1b-ab59-d1387e24dafb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a4143b82-99ad-41ae-8804-87cc0717e3b9",
      "EndDate": "2026-03-04T07:06:36.6248568+00:00",
      "StartDate": "2026-03-04T07:06:36.6248568+00:00",
      "SchedulePreferenceDate": "2026-03-04T07:06:36.6248568+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-03-04T07:06:36.6248568+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "5a78135a-7538-414c-8065-9871033ac09e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "995d069f-6fe3-418a-bbee-fce3734c2aa2",
      "Sequence": 1,
      "AncestorCategoryId": "8d1d8f00-fa95-4faa-b71c-1b55e74e4a7e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "5a78135a-7538-414c-8065-9871033ac09e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "995d069f-6fe3-418a-bbee-fce3734c2aa2",
      "Sequence": 1,
      "AncestorCategoryId": "8d1d8f00-fa95-4faa-b71c-1b55e74e4a7e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "9bd5cec1-e535-4b9a-a9e4-361fa503a7db",
    "CategoryId": "3617c486-de33-457d-97eb-8ba74f507a55",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ee011a2a-68e9-43a7-9752-6244e4168f2f",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ee011a2a-68e9-43a7-9752-6244e4168f2f",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "902e6d1b-0e7f-43f4-ac17-823fd3e29bee",
      "Questions": [
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "902e6d1b-0e7f-43f4-ac17-823fd3e29bee",
      "Questions": [
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "03427910-0040-4833-b159-80ccf3230f3c",
      "ContentItemId": "5dc35ba9-dbda-45d4-9586-97a63790b2a6",
      "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-03-04T07:06:36.6248568+00:00",
      "RescheduleDate": "2026-03-04T07:06:36.6248568+00:00"
    },
    {
      "Id": "03427910-0040-4833-b159-80ccf3230f3c",
      "ContentItemId": "5dc35ba9-dbda-45d4-9586-97a63790b2a6",
      "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-03-04T07:06:36.6248568+00:00",
      "RescheduleDate": "2026-03-04T07:06:36.6248568+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": "e3d5d64e-bace-4558-80d3-4aebda9bf341",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-04T07:06:36.6561123+00:00",
  "Registration": [
    {
      "Id": "19d5ff84-0d16-441f-93a6-6947812a1dbe",
      "UserId": "060987f1-7e87-4e70-a2e5-36f675533599",
      "IsCurrent": true,
      "CenterId": "eb766bd2-fcb5-4f1b-ab59-d1387e24dafb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a4143b82-99ad-41ae-8804-87cc0717e3b9",
      "EndDate": "2026-03-04T07:06:36.6248568+00:00",
      "StartDate": "2026-03-04T07:06:36.6248568+00:00",
      "SchedulePreferenceDate": "2026-03-04T07:06:36.6248568+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": "19d5ff84-0d16-441f-93a6-6947812a1dbe",
      "UserId": "060987f1-7e87-4e70-a2e5-36f675533599",
      "IsCurrent": true,
      "CenterId": "eb766bd2-fcb5-4f1b-ab59-d1387e24dafb",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "a4143b82-99ad-41ae-8804-87cc0717e3b9",
      "EndDate": "2026-03-04T07:06:36.6248568+00:00",
      "StartDate": "2026-03-04T07:06:36.6248568+00:00",
      "SchedulePreferenceDate": "2026-03-04T07:06:36.6248568+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-03-04T07:06:36.6248568+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "5a78135a-7538-414c-8065-9871033ac09e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "995d069f-6fe3-418a-bbee-fce3734c2aa2",
      "Sequence": 1,
      "AncestorCategoryId": "8d1d8f00-fa95-4faa-b71c-1b55e74e4a7e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "5a78135a-7538-414c-8065-9871033ac09e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "995d069f-6fe3-418a-bbee-fce3734c2aa2",
      "Sequence": 1,
      "AncestorCategoryId": "8d1d8f00-fa95-4faa-b71c-1b55e74e4a7e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "86390934-77b6-4c41-aaec-a045266c4bdf",
          "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": "9bd5cec1-e535-4b9a-a9e4-361fa503a7db",
    "CategoryId": "3617c486-de33-457d-97eb-8ba74f507a55",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ee011a2a-68e9-43a7-9752-6244e4168f2f",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ee011a2a-68e9-43a7-9752-6244e4168f2f",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "902e6d1b-0e7f-43f4-ac17-823fd3e29bee",
      "Questions": [
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "902e6d1b-0e7f-43f4-ac17-823fd3e29bee",
      "Questions": [
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        },
        {
          "Id": "8b6b85b1-b57c-4e27-926c-4d4fed710e88",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "03427910-0040-4833-b159-80ccf3230f3c",
      "ContentItemId": "5dc35ba9-dbda-45d4-9586-97a63790b2a6",
      "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-03-04T07:06:36.6248568+00:00",
      "RescheduleDate": "2026-03-04T07:06:36.6248568+00:00"
    },
    {
      "Id": "03427910-0040-4833-b159-80ccf3230f3c",
      "ContentItemId": "5dc35ba9-dbda-45d4-9586-97a63790b2a6",
      "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-03-04T07:06:36.6248568+00:00",
      "RescheduleDate": "2026-03-04T07:06:36.6248568+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}