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": "34b79fe1-b35c-47ac-8a86-bcf996b006b5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-02T19:07:46.2497447+00:00",
  "Registration": [
    {
      "Id": "b3deb272-e2aa-4872-8764-2db2fb38640a",
      "UserId": "5814fc1c-d107-46e7-98e9-874ea8cc1d5c",
      "IsCurrent": true,
      "CenterId": "70813d57-52b4-4ba3-b3c7-1089f56da0ee",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "67cc46a0-e492-41ad-9453-f0f821853bec",
      "EndDate": "2026-11-02T19:07:46.2497447+00:00",
      "StartDate": "2026-11-02T19:07:46.2497447+00:00",
      "SchedulePreferenceDate": "2026-11-02T19:07:46.2497447+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": "b3deb272-e2aa-4872-8764-2db2fb38640a",
      "UserId": "5814fc1c-d107-46e7-98e9-874ea8cc1d5c",
      "IsCurrent": true,
      "CenterId": "70813d57-52b4-4ba3-b3c7-1089f56da0ee",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "67cc46a0-e492-41ad-9453-f0f821853bec",
      "EndDate": "2026-11-02T19:07:46.2497447+00:00",
      "StartDate": "2026-11-02T19:07:46.2497447+00:00",
      "SchedulePreferenceDate": "2026-11-02T19:07:46.2497447+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-11-02T19:07:46.2497447+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "1dcc68b5-6072-4c77-94f6-33dcee9eabad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1af9eff4-bd8e-47fa-83a2-6a1d75914b6f",
      "Sequence": 1,
      "AncestorCategoryId": "11485db3-a055-4a01-a722-e44706509d94",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "1dcc68b5-6072-4c77-94f6-33dcee9eabad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1af9eff4-bd8e-47fa-83a2-6a1d75914b6f",
      "Sequence": 1,
      "AncestorCategoryId": "11485db3-a055-4a01-a722-e44706509d94",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "1eab4e34-4513-4ec1-9814-622c330b86df",
    "CategoryId": "75aa3a97-faf7-41d1-95c6-92dc56d58a84",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "cbefd803-771c-4626-8091-23002d6ebaca",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "cbefd803-771c-4626-8091-23002d6ebaca",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "78b2a366-1ef5-4f03-a93b-ae21e87b72d0",
      "Questions": [
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        },
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "78b2a366-1ef5-4f03-a93b-ae21e87b72d0",
      "Questions": [
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        },
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "b3ee9fc1-94d1-4b3b-a426-eb3126c1f976",
      "ContentItemId": "a244f987-0b5f-4a5d-9b64-2da3e3d09cca",
      "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-11-02T19:07:46.2497447+00:00",
      "RescheduleDate": "2026-11-02T19:07:46.2497447+00:00"
    },
    {
      "Id": "b3ee9fc1-94d1-4b3b-a426-eb3126c1f976",
      "ContentItemId": "a244f987-0b5f-4a5d-9b64-2da3e3d09cca",
      "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-11-02T19:07:46.2497447+00:00",
      "RescheduleDate": "2026-11-02T19:07:46.2497447+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": "34b79fe1-b35c-47ac-8a86-bcf996b006b5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-02T19:07:46.2966208+00:00",
  "Registration": [
    {
      "Id": "b3deb272-e2aa-4872-8764-2db2fb38640a",
      "UserId": "5814fc1c-d107-46e7-98e9-874ea8cc1d5c",
      "IsCurrent": true,
      "CenterId": "70813d57-52b4-4ba3-b3c7-1089f56da0ee",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "67cc46a0-e492-41ad-9453-f0f821853bec",
      "EndDate": "2026-11-02T19:07:46.2497447+00:00",
      "StartDate": "2026-11-02T19:07:46.2497447+00:00",
      "SchedulePreferenceDate": "2026-11-02T19:07:46.2497447+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": "b3deb272-e2aa-4872-8764-2db2fb38640a",
      "UserId": "5814fc1c-d107-46e7-98e9-874ea8cc1d5c",
      "IsCurrent": true,
      "CenterId": "70813d57-52b4-4ba3-b3c7-1089f56da0ee",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "67cc46a0-e492-41ad-9453-f0f821853bec",
      "EndDate": "2026-11-02T19:07:46.2497447+00:00",
      "StartDate": "2026-11-02T19:07:46.2497447+00:00",
      "SchedulePreferenceDate": "2026-11-02T19:07:46.2497447+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-11-02T19:07:46.2497447+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "1dcc68b5-6072-4c77-94f6-33dcee9eabad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1af9eff4-bd8e-47fa-83a2-6a1d75914b6f",
      "Sequence": 1,
      "AncestorCategoryId": "11485db3-a055-4a01-a722-e44706509d94",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "1dcc68b5-6072-4c77-94f6-33dcee9eabad",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "1af9eff4-bd8e-47fa-83a2-6a1d75914b6f",
      "Sequence": 1,
      "AncestorCategoryId": "11485db3-a055-4a01-a722-e44706509d94",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "4264e3cd-96c1-457a-96ee-bb74c8c34a52",
          "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": "1eab4e34-4513-4ec1-9814-622c330b86df",
    "CategoryId": "75aa3a97-faf7-41d1-95c6-92dc56d58a84",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "cbefd803-771c-4626-8091-23002d6ebaca",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "cbefd803-771c-4626-8091-23002d6ebaca",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "78b2a366-1ef5-4f03-a93b-ae21e87b72d0",
      "Questions": [
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        },
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "78b2a366-1ef5-4f03-a93b-ae21e87b72d0",
      "Questions": [
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        },
        {
          "Id": "87714555-4b4a-44cb-a290-eac39ad67b1d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "b3ee9fc1-94d1-4b3b-a426-eb3126c1f976",
      "ContentItemId": "a244f987-0b5f-4a5d-9b64-2da3e3d09cca",
      "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-11-02T19:07:46.2497447+00:00",
      "RescheduleDate": "2026-11-02T19:07:46.2497447+00:00"
    },
    {
      "Id": "b3ee9fc1-94d1-4b3b-a426-eb3126c1f976",
      "ContentItemId": "a244f987-0b5f-4a5d-9b64-2da3e3d09cca",
      "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-11-02T19:07:46.2497447+00:00",
      "RescheduleDate": "2026-11-02T19:07:46.2497447+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}