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.

Response Formats

application/json

Sample: 
{
  "UserId": "0c1b821d-c27c-4144-9225-a72be62618db",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-08-29T05:16:21.9340578+00:00",
  "Registration": [
    {
      "Id": "b5844bbc-5e90-40b0-a286-54a00bab07c7",
      "UserId": "4cdf4805-f221-4072-a9b6-3cf5837398c6",
      "IsCurrent": true,
      "CenterId": "cbeb5122-b772-43b9-b05d-ed3eeeeeea86",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "05c07a84-924b-4062-81d4-f1ac54955721",
      "EndDate": "2025-08-29T05:16:21.9184323+00:00",
      "StartDate": "2025-08-29T05:16:21.9184323+00:00",
      "SchedulePreferenceDate": "2025-08-29T05:16:21.9184323+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": "b5844bbc-5e90-40b0-a286-54a00bab07c7",
      "UserId": "4cdf4805-f221-4072-a9b6-3cf5837398c6",
      "IsCurrent": true,
      "CenterId": "cbeb5122-b772-43b9-b05d-ed3eeeeeea86",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "05c07a84-924b-4062-81d4-f1ac54955721",
      "EndDate": "2025-08-29T05:16:21.9184323+00:00",
      "StartDate": "2025-08-29T05:16:21.9184323+00:00",
      "SchedulePreferenceDate": "2025-08-29T05:16:21.9184323+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-08-29T05:16:21.9340578+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f8b2f490-2ff2-4977-b0d1-215ce3c653e7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2097a947-9965-4f19-abc1-ac6b1514fd4c",
      "Sequence": 1,
      "AncestorCategoryId": "742fdac2-1590-45bd-9ae5-6ca5908656f9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "f8b2f490-2ff2-4977-b0d1-215ce3c653e7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2097a947-9965-4f19-abc1-ac6b1514fd4c",
      "Sequence": 1,
      "AncestorCategoryId": "742fdac2-1590-45bd-9ae5-6ca5908656f9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "8e231d58-5d2c-46ea-849a-5c9c80329a14",
    "CategoryId": "28e7afd7-2001-41a2-855b-d532e7399853",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e0313b6f-250b-4dc0-85a7-33451fe1b3c8",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e0313b6f-250b-4dc0-85a7-33451fe1b3c8",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "377bc461-199b-445e-bacd-1d33324ba371",
      "Questions": [
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        },
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "377bc461-199b-445e-bacd-1d33324ba371",
      "Questions": [
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        },
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0f431221-00d4-4633-b915-e33c9fdc2b2d",
      "ContentItemId": "1d7d5fe3-ea52-4794-8e07-c83afc0847d8",
      "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-08-29T05:16:21.9340578+00:00",
      "RescheduleDate": "2025-08-29T05:16:21.9340578+00:00"
    },
    {
      "Id": "0f431221-00d4-4633-b915-e33c9fdc2b2d",
      "ContentItemId": "1d7d5fe3-ea52-4794-8e07-c83afc0847d8",
      "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-08-29T05:16:21.9340578+00:00",
      "RescheduleDate": "2025-08-29T05:16:21.9340578+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "0c1b821d-c27c-4144-9225-a72be62618db",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-08-29T05:16:21.980938+00:00",
  "Registration": [
    {
      "Id": "b5844bbc-5e90-40b0-a286-54a00bab07c7",
      "UserId": "4cdf4805-f221-4072-a9b6-3cf5837398c6",
      "IsCurrent": true,
      "CenterId": "cbeb5122-b772-43b9-b05d-ed3eeeeeea86",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "05c07a84-924b-4062-81d4-f1ac54955721",
      "EndDate": "2025-08-29T05:16:21.9184323+00:00",
      "StartDate": "2025-08-29T05:16:21.9184323+00:00",
      "SchedulePreferenceDate": "2025-08-29T05:16:21.9184323+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": "b5844bbc-5e90-40b0-a286-54a00bab07c7",
      "UserId": "4cdf4805-f221-4072-a9b6-3cf5837398c6",
      "IsCurrent": true,
      "CenterId": "cbeb5122-b772-43b9-b05d-ed3eeeeeea86",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "05c07a84-924b-4062-81d4-f1ac54955721",
      "EndDate": "2025-08-29T05:16:21.9184323+00:00",
      "StartDate": "2025-08-29T05:16:21.9184323+00:00",
      "SchedulePreferenceDate": "2025-08-29T05:16:21.9184323+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-08-29T05:16:21.9340578+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f8b2f490-2ff2-4977-b0d1-215ce3c653e7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2097a947-9965-4f19-abc1-ac6b1514fd4c",
      "Sequence": 1,
      "AncestorCategoryId": "742fdac2-1590-45bd-9ae5-6ca5908656f9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "f8b2f490-2ff2-4977-b0d1-215ce3c653e7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2097a947-9965-4f19-abc1-ac6b1514fd4c",
      "Sequence": 1,
      "AncestorCategoryId": "742fdac2-1590-45bd-9ae5-6ca5908656f9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "a58c6de6-d761-4912-addb-b2416432153e",
          "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": "8e231d58-5d2c-46ea-849a-5c9c80329a14",
    "CategoryId": "28e7afd7-2001-41a2-855b-d532e7399853",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e0313b6f-250b-4dc0-85a7-33451fe1b3c8",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e0313b6f-250b-4dc0-85a7-33451fe1b3c8",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "377bc461-199b-445e-bacd-1d33324ba371",
      "Questions": [
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        },
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "377bc461-199b-445e-bacd-1d33324ba371",
      "Questions": [
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        },
        {
          "Id": "1232e663-efdd-468a-b57a-6cb3b458afa7",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0f431221-00d4-4633-b915-e33c9fdc2b2d",
      "ContentItemId": "1d7d5fe3-ea52-4794-8e07-c83afc0847d8",
      "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-08-29T05:16:21.9340578+00:00",
      "RescheduleDate": "2025-08-29T05:16:21.9340578+00:00"
    },
    {
      "Id": "0f431221-00d4-4633-b915-e33c9fdc2b2d",
      "ContentItemId": "1d7d5fe3-ea52-4794-8e07-c83afc0847d8",
      "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-08-29T05:16:21.9340578+00:00",
      "RescheduleDate": "2025-08-29T05:16:21.9340578+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}