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": "fc632924-9fea-4591-b41a-36e8c27a7bd8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-11T12:20:52.4578211+00:00",
  "Registration": [
    {
      "Id": "c253fe8e-3ad9-463d-895c-0076ef74b955",
      "UserId": "dabc5de0-eb2c-43be-bf81-85d12219d56b",
      "IsCurrent": true,
      "CenterId": "593d8469-4d82-4523-88ee-eec229dbadc8",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "2006f5f6-4fe2-41a6-a971-c5e0a5df196c",
      "EndDate": "2026-02-11T12:20:52.4578211+00:00",
      "StartDate": "2026-02-11T12:20:52.4578211+00:00",
      "SchedulePreferenceDate": "2026-02-11T12:20:52.4578211+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": "c253fe8e-3ad9-463d-895c-0076ef74b955",
      "UserId": "dabc5de0-eb2c-43be-bf81-85d12219d56b",
      "IsCurrent": true,
      "CenterId": "593d8469-4d82-4523-88ee-eec229dbadc8",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "2006f5f6-4fe2-41a6-a971-c5e0a5df196c",
      "EndDate": "2026-02-11T12:20:52.4578211+00:00",
      "StartDate": "2026-02-11T12:20:52.4578211+00:00",
      "SchedulePreferenceDate": "2026-02-11T12:20:52.4578211+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-02-11T12:20:52.4578211+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4083729c-b329-48c9-a078-5a91ef164448",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1fd59cbd-ca25-4513-805e-0cd502390859",
      "Sequence": 1,
      "AncestorCategoryId": "70f1059b-ab6b-45dd-84f0-368197ba49f0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "4083729c-b329-48c9-a078-5a91ef164448",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1fd59cbd-ca25-4513-805e-0cd502390859",
      "Sequence": 1,
      "AncestorCategoryId": "70f1059b-ab6b-45dd-84f0-368197ba49f0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "f1c1a700-e8dc-4b93-80bf-3470ab324601",
    "CategoryId": "8796654a-969c-4af8-9d13-57537b678e53",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "015d8e1a-f574-4b39-92e0-791d7906e4e1",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "015d8e1a-f574-4b39-92e0-791d7906e4e1",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "abaaa07c-6198-46fb-8198-01c94a2019be",
      "Questions": [
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        },
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "abaaa07c-6198-46fb-8198-01c94a2019be",
      "Questions": [
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        },
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "80bbc8db-b5f5-4f99-879b-404f7ec642da",
      "ContentItemId": "703d25e8-b6f4-4fb4-b7b0-674eac0dec38",
      "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-02-11T12:20:52.4578211+00:00",
      "RescheduleDate": "2026-02-11T12:20:52.4578211+00:00"
    },
    {
      "Id": "80bbc8db-b5f5-4f99-879b-404f7ec642da",
      "ContentItemId": "703d25e8-b6f4-4fb4-b7b0-674eac0dec38",
      "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-02-11T12:20:52.4578211+00:00",
      "RescheduleDate": "2026-02-11T12:20:52.4578211+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": "fc632924-9fea-4591-b41a-36e8c27a7bd8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-11T12:20:52.4890742+00:00",
  "Registration": [
    {
      "Id": "c253fe8e-3ad9-463d-895c-0076ef74b955",
      "UserId": "dabc5de0-eb2c-43be-bf81-85d12219d56b",
      "IsCurrent": true,
      "CenterId": "593d8469-4d82-4523-88ee-eec229dbadc8",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "2006f5f6-4fe2-41a6-a971-c5e0a5df196c",
      "EndDate": "2026-02-11T12:20:52.4578211+00:00",
      "StartDate": "2026-02-11T12:20:52.4578211+00:00",
      "SchedulePreferenceDate": "2026-02-11T12:20:52.4578211+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": "c253fe8e-3ad9-463d-895c-0076ef74b955",
      "UserId": "dabc5de0-eb2c-43be-bf81-85d12219d56b",
      "IsCurrent": true,
      "CenterId": "593d8469-4d82-4523-88ee-eec229dbadc8",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "2006f5f6-4fe2-41a6-a971-c5e0a5df196c",
      "EndDate": "2026-02-11T12:20:52.4578211+00:00",
      "StartDate": "2026-02-11T12:20:52.4578211+00:00",
      "SchedulePreferenceDate": "2026-02-11T12:20:52.4578211+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-02-11T12:20:52.4578211+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4083729c-b329-48c9-a078-5a91ef164448",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1fd59cbd-ca25-4513-805e-0cd502390859",
      "Sequence": 1,
      "AncestorCategoryId": "70f1059b-ab6b-45dd-84f0-368197ba49f0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "4083729c-b329-48c9-a078-5a91ef164448",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1fd59cbd-ca25-4513-805e-0cd502390859",
      "Sequence": 1,
      "AncestorCategoryId": "70f1059b-ab6b-45dd-84f0-368197ba49f0",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "a6261478-b9bc-4676-8b1c-e1fe01179ef1",
          "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": "f1c1a700-e8dc-4b93-80bf-3470ab324601",
    "CategoryId": "8796654a-969c-4af8-9d13-57537b678e53",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "015d8e1a-f574-4b39-92e0-791d7906e4e1",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "015d8e1a-f574-4b39-92e0-791d7906e4e1",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "abaaa07c-6198-46fb-8198-01c94a2019be",
      "Questions": [
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        },
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "abaaa07c-6198-46fb-8198-01c94a2019be",
      "Questions": [
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        },
        {
          "Id": "710e4538-106b-44fb-86fa-e4e0d21373ef",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "80bbc8db-b5f5-4f99-879b-404f7ec642da",
      "ContentItemId": "703d25e8-b6f4-4fb4-b7b0-674eac0dec38",
      "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-02-11T12:20:52.4578211+00:00",
      "RescheduleDate": "2026-02-11T12:20:52.4578211+00:00"
    },
    {
      "Id": "80bbc8db-b5f5-4f99-879b-404f7ec642da",
      "ContentItemId": "703d25e8-b6f4-4fb4-b7b0-674eac0dec38",
      "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-02-11T12:20:52.4578211+00:00",
      "RescheduleDate": "2026-02-11T12:20:52.4578211+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}