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": "92a79c80-3ef4-443c-a29e-90dc460536d5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-08T20:44:59.873208+00:00",
  "Registration": [
    {
      "Id": "7f820f27-263d-4247-bd1c-51c6222a4e4a",
      "UserId": "5d927de3-78a2-4a01-b17b-b96aaa82b217",
      "IsCurrent": true,
      "CenterId": "753463f4-b7cf-4fbe-b2cd-183d3699448e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "18d71bfb-3b5e-4c7c-87ef-ffaea7ce3c32",
      "EndDate": "2025-11-08T20:44:59.873208+00:00",
      "StartDate": "2025-11-08T20:44:59.873208+00:00",
      "SchedulePreferenceDate": "2025-11-08T20:44:59.873208+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": "7f820f27-263d-4247-bd1c-51c6222a4e4a",
      "UserId": "5d927de3-78a2-4a01-b17b-b96aaa82b217",
      "IsCurrent": true,
      "CenterId": "753463f4-b7cf-4fbe-b2cd-183d3699448e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "18d71bfb-3b5e-4c7c-87ef-ffaea7ce3c32",
      "EndDate": "2025-11-08T20:44:59.873208+00:00",
      "StartDate": "2025-11-08T20:44:59.873208+00:00",
      "SchedulePreferenceDate": "2025-11-08T20:44:59.873208+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-11-08T20:44:59.873208+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "346011ee-e68a-449c-b596-f4868d939f70",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b4203d4-e6f8-4832-a0d0-c50bc15a7017",
      "Sequence": 1,
      "AncestorCategoryId": "810cefe4-f7c7-4b0d-8c3a-43d67a1e9f35",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "346011ee-e68a-449c-b596-f4868d939f70",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b4203d4-e6f8-4832-a0d0-c50bc15a7017",
      "Sequence": 1,
      "AncestorCategoryId": "810cefe4-f7c7-4b0d-8c3a-43d67a1e9f35",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "5c3ce996-04f2-416e-9655-4b611777720f",
    "CategoryId": "1cb56f65-30f7-45dd-906e-bd3784d7e14a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "cc0915cc-abae-4a04-a44d-616d45ca8e52",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "cc0915cc-abae-4a04-a44d-616d45ca8e52",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "40d21283-4de6-492c-a5b7-bd03eeedf7da",
      "Questions": [
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        },
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "40d21283-4de6-492c-a5b7-bd03eeedf7da",
      "Questions": [
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        },
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ca124dc0-8ae7-49b5-8aa3-73b30ebd8f46",
      "ContentItemId": "66f7def6-9c02-4914-b54a-4ab08b392151",
      "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-11-08T20:44:59.873208+00:00",
      "RescheduleDate": "2025-11-08T20:44:59.873208+00:00"
    },
    {
      "Id": "ca124dc0-8ae7-49b5-8aa3-73b30ebd8f46",
      "ContentItemId": "66f7def6-9c02-4914-b54a-4ab08b392151",
      "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-11-08T20:44:59.873208+00:00",
      "RescheduleDate": "2025-11-08T20:44:59.873208+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": "92a79c80-3ef4-443c-a29e-90dc460536d5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-08T20:44:59.9200847+00:00",
  "Registration": [
    {
      "Id": "7f820f27-263d-4247-bd1c-51c6222a4e4a",
      "UserId": "5d927de3-78a2-4a01-b17b-b96aaa82b217",
      "IsCurrent": true,
      "CenterId": "753463f4-b7cf-4fbe-b2cd-183d3699448e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "18d71bfb-3b5e-4c7c-87ef-ffaea7ce3c32",
      "EndDate": "2025-11-08T20:44:59.873208+00:00",
      "StartDate": "2025-11-08T20:44:59.873208+00:00",
      "SchedulePreferenceDate": "2025-11-08T20:44:59.873208+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": "7f820f27-263d-4247-bd1c-51c6222a4e4a",
      "UserId": "5d927de3-78a2-4a01-b17b-b96aaa82b217",
      "IsCurrent": true,
      "CenterId": "753463f4-b7cf-4fbe-b2cd-183d3699448e",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "18d71bfb-3b5e-4c7c-87ef-ffaea7ce3c32",
      "EndDate": "2025-11-08T20:44:59.873208+00:00",
      "StartDate": "2025-11-08T20:44:59.873208+00:00",
      "SchedulePreferenceDate": "2025-11-08T20:44:59.873208+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-11-08T20:44:59.873208+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "346011ee-e68a-449c-b596-f4868d939f70",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b4203d4-e6f8-4832-a0d0-c50bc15a7017",
      "Sequence": 1,
      "AncestorCategoryId": "810cefe4-f7c7-4b0d-8c3a-43d67a1e9f35",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "346011ee-e68a-449c-b596-f4868d939f70",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b4203d4-e6f8-4832-a0d0-c50bc15a7017",
      "Sequence": 1,
      "AncestorCategoryId": "810cefe4-f7c7-4b0d-8c3a-43d67a1e9f35",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "12c05009-e319-44c7-bba8-b346201ac449",
          "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": "5c3ce996-04f2-416e-9655-4b611777720f",
    "CategoryId": "1cb56f65-30f7-45dd-906e-bd3784d7e14a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "cc0915cc-abae-4a04-a44d-616d45ca8e52",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "cc0915cc-abae-4a04-a44d-616d45ca8e52",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "40d21283-4de6-492c-a5b7-bd03eeedf7da",
      "Questions": [
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        },
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "40d21283-4de6-492c-a5b7-bd03eeedf7da",
      "Questions": [
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        },
        {
          "Id": "874fe9f1-ab9f-4940-8ca2-6b641e4cfd58",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ca124dc0-8ae7-49b5-8aa3-73b30ebd8f46",
      "ContentItemId": "66f7def6-9c02-4914-b54a-4ab08b392151",
      "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-11-08T20:44:59.873208+00:00",
      "RescheduleDate": "2025-11-08T20:44:59.873208+00:00"
    },
    {
      "Id": "ca124dc0-8ae7-49b5-8aa3-73b30ebd8f46",
      "ContentItemId": "66f7def6-9c02-4914-b54a-4ab08b392151",
      "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-11-08T20:44:59.873208+00:00",
      "RescheduleDate": "2025-11-08T20:44:59.873208+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}