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": "cbe24558-2633-4ec1-92fb-4de89f73bd71",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-08-31T21:05:12.4931383+00:00",
  "Registration": [
    {
      "Id": "112523c0-a826-4759-9fdb-4b6950580031",
      "UserId": "8b043f7d-0e3f-4967-9e69-ae76d30456f4",
      "IsCurrent": true,
      "CenterId": "719aada0-5843-432c-9625-a5636afca9de",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ef0e5470-7a0c-4603-96e1-94c2df1d9db7",
      "EndDate": "2025-08-31T21:05:12.4781409+00:00",
      "StartDate": "2025-08-31T21:05:12.4781409+00:00",
      "SchedulePreferenceDate": "2025-08-31T21:05:12.4781409+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": "112523c0-a826-4759-9fdb-4b6950580031",
      "UserId": "8b043f7d-0e3f-4967-9e69-ae76d30456f4",
      "IsCurrent": true,
      "CenterId": "719aada0-5843-432c-9625-a5636afca9de",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ef0e5470-7a0c-4603-96e1-94c2df1d9db7",
      "EndDate": "2025-08-31T21:05:12.4781409+00:00",
      "StartDate": "2025-08-31T21:05:12.4781409+00:00",
      "SchedulePreferenceDate": "2025-08-31T21:05:12.4781409+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-31T21:05:12.4931383+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "47e51a02-2576-475b-bdcd-9770c46a61c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "91319134-4d83-407e-9da6-a3bce6189846",
      "Sequence": 1,
      "AncestorCategoryId": "dc3e245b-e521-4be6-a50f-8db92d25f4a4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "47e51a02-2576-475b-bdcd-9770c46a61c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "91319134-4d83-407e-9da6-a3bce6189846",
      "Sequence": 1,
      "AncestorCategoryId": "dc3e245b-e521-4be6-a50f-8db92d25f4a4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "fe042a53-2175-43f3-8949-cf648391221a",
    "CategoryId": "63722260-67a8-4aed-b803-3f04b543546a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1c3bdbe7-9a7b-439f-b58c-ae5cf96e0269",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1c3bdbe7-9a7b-439f-b58c-ae5cf96e0269",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "a6994423-e1e5-42ec-bddb-ed189ec8519f",
      "Questions": [
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        },
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "a6994423-e1e5-42ec-bddb-ed189ec8519f",
      "Questions": [
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        },
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1ce18a88-e98d-4008-a851-5fd33d3882e5",
      "ContentItemId": "4f762ae7-05d3-4e9a-aa67-f9fda4950553",
      "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-31T21:05:12.4931383+00:00",
      "RescheduleDate": "2025-08-31T21:05:12.4931383+00:00"
    },
    {
      "Id": "1ce18a88-e98d-4008-a851-5fd33d3882e5",
      "ContentItemId": "4f762ae7-05d3-4e9a-aa67-f9fda4950553",
      "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-31T21:05:12.4931383+00:00",
      "RescheduleDate": "2025-08-31T21:05:12.4931383+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample: 
{
  "UserId": "cbe24558-2633-4ec1-92fb-4de89f73bd71",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-08-31T21:05:12.5556399+00:00",
  "Registration": [
    {
      "Id": "112523c0-a826-4759-9fdb-4b6950580031",
      "UserId": "8b043f7d-0e3f-4967-9e69-ae76d30456f4",
      "IsCurrent": true,
      "CenterId": "719aada0-5843-432c-9625-a5636afca9de",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ef0e5470-7a0c-4603-96e1-94c2df1d9db7",
      "EndDate": "2025-08-31T21:05:12.4781409+00:00",
      "StartDate": "2025-08-31T21:05:12.4781409+00:00",
      "SchedulePreferenceDate": "2025-08-31T21:05:12.4781409+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": "112523c0-a826-4759-9fdb-4b6950580031",
      "UserId": "8b043f7d-0e3f-4967-9e69-ae76d30456f4",
      "IsCurrent": true,
      "CenterId": "719aada0-5843-432c-9625-a5636afca9de",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "ef0e5470-7a0c-4603-96e1-94c2df1d9db7",
      "EndDate": "2025-08-31T21:05:12.4781409+00:00",
      "StartDate": "2025-08-31T21:05:12.4781409+00:00",
      "SchedulePreferenceDate": "2025-08-31T21:05:12.4781409+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-31T21:05:12.4931383+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "47e51a02-2576-475b-bdcd-9770c46a61c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "91319134-4d83-407e-9da6-a3bce6189846",
      "Sequence": 1,
      "AncestorCategoryId": "dc3e245b-e521-4be6-a50f-8db92d25f4a4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "47e51a02-2576-475b-bdcd-9770c46a61c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "91319134-4d83-407e-9da6-a3bce6189846",
      "Sequence": 1,
      "AncestorCategoryId": "dc3e245b-e521-4be6-a50f-8db92d25f4a4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "59ae5c14-bc66-4aaf-b1d9-ec5dd7a8f816",
          "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": "fe042a53-2175-43f3-8949-cf648391221a",
    "CategoryId": "63722260-67a8-4aed-b803-3f04b543546a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1c3bdbe7-9a7b-439f-b58c-ae5cf96e0269",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1c3bdbe7-9a7b-439f-b58c-ae5cf96e0269",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "a6994423-e1e5-42ec-bddb-ed189ec8519f",
      "Questions": [
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        },
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "a6994423-e1e5-42ec-bddb-ed189ec8519f",
      "Questions": [
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        },
        {
          "Id": "dda64ada-323d-40bf-aa10-c05e4039120e",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1ce18a88-e98d-4008-a851-5fd33d3882e5",
      "ContentItemId": "4f762ae7-05d3-4e9a-aa67-f9fda4950553",
      "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-31T21:05:12.4931383+00:00",
      "RescheduleDate": "2025-08-31T21:05:12.4931383+00:00"
    },
    {
      "Id": "1ce18a88-e98d-4008-a851-5fd33d3882e5",
      "ContentItemId": "4f762ae7-05d3-4e9a-aa67-f9fda4950553",
      "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-31T21:05:12.4931383+00:00",
      "RescheduleDate": "2025-08-31T21:05:12.4931383+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}