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": "25271a0b-426a-4f56-b905-8398087c25a7",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-25T12:41:16.5912232+00:00",
  "Registration": [
    {
      "Id": "5f4de7b3-0d45-4aa8-b5f6-5e34f7764e6b",
      "UserId": "ab5e58ab-a383-4ca6-842d-b6de4570f6a5",
      "IsCurrent": true,
      "CenterId": "d25b7d82-4694-48ea-af69-567dd4eb581b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d02d487d-b23b-4e16-8d20-71c91e75f530",
      "EndDate": "2026-09-25T12:41:16.575595+00:00",
      "StartDate": "2026-09-25T12:41:16.575595+00:00",
      "SchedulePreferenceDate": "2026-09-25T12:41:16.575595+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": "5f4de7b3-0d45-4aa8-b5f6-5e34f7764e6b",
      "UserId": "ab5e58ab-a383-4ca6-842d-b6de4570f6a5",
      "IsCurrent": true,
      "CenterId": "d25b7d82-4694-48ea-af69-567dd4eb581b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d02d487d-b23b-4e16-8d20-71c91e75f530",
      "EndDate": "2026-09-25T12:41:16.575595+00:00",
      "StartDate": "2026-09-25T12:41:16.575595+00:00",
      "SchedulePreferenceDate": "2026-09-25T12:41:16.575595+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-09-25T12:41:16.575595+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4c180a87-806d-48db-8931-b6de759518cf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b3199830-82f1-49fc-ba20-3a7ae78cbd15",
      "Sequence": 1,
      "AncestorCategoryId": "31a7d9d7-0d05-40be-910d-5510a8dfeafd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "4c180a87-806d-48db-8931-b6de759518cf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b3199830-82f1-49fc-ba20-3a7ae78cbd15",
      "Sequence": 1,
      "AncestorCategoryId": "31a7d9d7-0d05-40be-910d-5510a8dfeafd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "6cb98494-7e52-45b1-b5a0-5aa971aedfd2",
    "CategoryId": "5f45f315-bc4c-45cb-991b-15d158f6779f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0ec9f783-c5ca-4341-a6c7-8a3062856922",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0ec9f783-c5ca-4341-a6c7-8a3062856922",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "0ab5856f-053c-479c-9eed-4d03d77dd3a0",
      "Questions": [
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        },
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "0ab5856f-053c-479c-9eed-4d03d77dd3a0",
      "Questions": [
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        },
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1b5b5c73-5687-439b-bc9d-c2aa60f4e9f3",
      "ContentItemId": "61b48778-9b3a-4d08-9d04-979576415e87",
      "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-09-25T12:41:16.575595+00:00",
      "RescheduleDate": "2026-09-25T12:41:16.575595+00:00"
    },
    {
      "Id": "1b5b5c73-5687-439b-bc9d-c2aa60f4e9f3",
      "ContentItemId": "61b48778-9b3a-4d08-9d04-979576415e87",
      "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-09-25T12:41:16.575595+00:00",
      "RescheduleDate": "2026-09-25T12:41:16.575595+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": "25271a0b-426a-4f56-b905-8398087c25a7",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-25T12:41:16.6224729+00:00",
  "Registration": [
    {
      "Id": "5f4de7b3-0d45-4aa8-b5f6-5e34f7764e6b",
      "UserId": "ab5e58ab-a383-4ca6-842d-b6de4570f6a5",
      "IsCurrent": true,
      "CenterId": "d25b7d82-4694-48ea-af69-567dd4eb581b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d02d487d-b23b-4e16-8d20-71c91e75f530",
      "EndDate": "2026-09-25T12:41:16.575595+00:00",
      "StartDate": "2026-09-25T12:41:16.575595+00:00",
      "SchedulePreferenceDate": "2026-09-25T12:41:16.575595+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": "5f4de7b3-0d45-4aa8-b5f6-5e34f7764e6b",
      "UserId": "ab5e58ab-a383-4ca6-842d-b6de4570f6a5",
      "IsCurrent": true,
      "CenterId": "d25b7d82-4694-48ea-af69-567dd4eb581b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d02d487d-b23b-4e16-8d20-71c91e75f530",
      "EndDate": "2026-09-25T12:41:16.575595+00:00",
      "StartDate": "2026-09-25T12:41:16.575595+00:00",
      "SchedulePreferenceDate": "2026-09-25T12:41:16.575595+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-09-25T12:41:16.575595+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "4c180a87-806d-48db-8931-b6de759518cf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b3199830-82f1-49fc-ba20-3a7ae78cbd15",
      "Sequence": 1,
      "AncestorCategoryId": "31a7d9d7-0d05-40be-910d-5510a8dfeafd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "4c180a87-806d-48db-8931-b6de759518cf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "b3199830-82f1-49fc-ba20-3a7ae78cbd15",
      "Sequence": 1,
      "AncestorCategoryId": "31a7d9d7-0d05-40be-910d-5510a8dfeafd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "5abf5967-d983-4b31-b873-2d4e9ff25d61",
          "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": "6cb98494-7e52-45b1-b5a0-5aa971aedfd2",
    "CategoryId": "5f45f315-bc4c-45cb-991b-15d158f6779f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "0ec9f783-c5ca-4341-a6c7-8a3062856922",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "0ec9f783-c5ca-4341-a6c7-8a3062856922",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "0ab5856f-053c-479c-9eed-4d03d77dd3a0",
      "Questions": [
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        },
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "0ab5856f-053c-479c-9eed-4d03d77dd3a0",
      "Questions": [
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        },
        {
          "Id": "5fc4e0b3-1b8b-4ba8-b3f5-a160a1d9a1ab",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "1b5b5c73-5687-439b-bc9d-c2aa60f4e9f3",
      "ContentItemId": "61b48778-9b3a-4d08-9d04-979576415e87",
      "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-09-25T12:41:16.575595+00:00",
      "RescheduleDate": "2026-09-25T12:41:16.575595+00:00"
    },
    {
      "Id": "1b5b5c73-5687-439b-bc9d-c2aa60f4e9f3",
      "ContentItemId": "61b48778-9b3a-4d08-9d04-979576415e87",
      "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-09-25T12:41:16.575595+00:00",
      "RescheduleDate": "2026-09-25T12:41:16.575595+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}