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": "5a3f8ab4-9f53-4000-ab6f-65cb02693f3e",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-19T01:12:39.0780447+00:00",
  "Registration": [
    {
      "Id": "062cb856-161c-4cd5-b4bd-8363735cb957",
      "UserId": "57abcc49-b360-4cb3-be91-1168108e5e52",
      "IsCurrent": true,
      "CenterId": "a7bd92cc-fe64-47a5-94a3-61338bf3c3ae",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "90c7b049-0c7f-4a22-84e7-d4d58e8941ed",
      "EndDate": "2025-11-19T01:12:39.0624185+00:00",
      "StartDate": "2025-11-19T01:12:39.0624185+00:00",
      "SchedulePreferenceDate": "2025-11-19T01:12:39.0624185+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": "062cb856-161c-4cd5-b4bd-8363735cb957",
      "UserId": "57abcc49-b360-4cb3-be91-1168108e5e52",
      "IsCurrent": true,
      "CenterId": "a7bd92cc-fe64-47a5-94a3-61338bf3c3ae",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "90c7b049-0c7f-4a22-84e7-d4d58e8941ed",
      "EndDate": "2025-11-19T01:12:39.0624185+00:00",
      "StartDate": "2025-11-19T01:12:39.0624185+00:00",
      "SchedulePreferenceDate": "2025-11-19T01:12:39.0624185+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-19T01:12:39.0624185+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a993ed58-ac78-478d-bece-cde1cfff140e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "674081c2-da77-4710-83a4-c0a1c9e299ed",
      "Sequence": 1,
      "AncestorCategoryId": "39d95bc6-b1f6-4e1d-b832-4f81294e08ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "a993ed58-ac78-478d-bece-cde1cfff140e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "674081c2-da77-4710-83a4-c0a1c9e299ed",
      "Sequence": 1,
      "AncestorCategoryId": "39d95bc6-b1f6-4e1d-b832-4f81294e08ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "618c57f1-535c-4931-91d6-912de8579cda",
    "CategoryId": "ac9204b7-a6cc-4628-998c-e1892d765cd9",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "4c7c19d4-2363-4d1a-92d6-135dfa7576a3",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "4c7c19d4-2363-4d1a-92d6-135dfa7576a3",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "07d33187-230e-4ce3-b7c3-2541547fe675",
      "Questions": [
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        },
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "07d33187-230e-4ce3-b7c3-2541547fe675",
      "Questions": [
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        },
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "06a4d504-d0d6-4476-9c4c-5d193be9682f",
      "ContentItemId": "31775d77-f752-4cc5-af6e-dfbf0fc6746e",
      "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-19T01:12:39.0624185+00:00",
      "RescheduleDate": "2025-11-19T01:12:39.0624185+00:00"
    },
    {
      "Id": "06a4d504-d0d6-4476-9c4c-5d193be9682f",
      "ContentItemId": "31775d77-f752-4cc5-af6e-dfbf0fc6746e",
      "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-19T01:12:39.0624185+00:00",
      "RescheduleDate": "2025-11-19T01:12:39.0624185+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": "5a3f8ab4-9f53-4000-ab6f-65cb02693f3e",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-19T01:12:39.1092946+00:00",
  "Registration": [
    {
      "Id": "062cb856-161c-4cd5-b4bd-8363735cb957",
      "UserId": "57abcc49-b360-4cb3-be91-1168108e5e52",
      "IsCurrent": true,
      "CenterId": "a7bd92cc-fe64-47a5-94a3-61338bf3c3ae",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "90c7b049-0c7f-4a22-84e7-d4d58e8941ed",
      "EndDate": "2025-11-19T01:12:39.0624185+00:00",
      "StartDate": "2025-11-19T01:12:39.0624185+00:00",
      "SchedulePreferenceDate": "2025-11-19T01:12:39.0624185+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": "062cb856-161c-4cd5-b4bd-8363735cb957",
      "UserId": "57abcc49-b360-4cb3-be91-1168108e5e52",
      "IsCurrent": true,
      "CenterId": "a7bd92cc-fe64-47a5-94a3-61338bf3c3ae",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "90c7b049-0c7f-4a22-84e7-d4d58e8941ed",
      "EndDate": "2025-11-19T01:12:39.0624185+00:00",
      "StartDate": "2025-11-19T01:12:39.0624185+00:00",
      "SchedulePreferenceDate": "2025-11-19T01:12:39.0624185+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-19T01:12:39.0624185+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "a993ed58-ac78-478d-bece-cde1cfff140e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "674081c2-da77-4710-83a4-c0a1c9e299ed",
      "Sequence": 1,
      "AncestorCategoryId": "39d95bc6-b1f6-4e1d-b832-4f81294e08ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "a993ed58-ac78-478d-bece-cde1cfff140e",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "674081c2-da77-4710-83a4-c0a1c9e299ed",
      "Sequence": 1,
      "AncestorCategoryId": "39d95bc6-b1f6-4e1d-b832-4f81294e08ca",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "07a66fa2-7ea8-422e-8d9a-f69c11ab2aec",
          "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": "618c57f1-535c-4931-91d6-912de8579cda",
    "CategoryId": "ac9204b7-a6cc-4628-998c-e1892d765cd9",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "4c7c19d4-2363-4d1a-92d6-135dfa7576a3",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "4c7c19d4-2363-4d1a-92d6-135dfa7576a3",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "07d33187-230e-4ce3-b7c3-2541547fe675",
      "Questions": [
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        },
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "07d33187-230e-4ce3-b7c3-2541547fe675",
      "Questions": [
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        },
        {
          "Id": "29b940f6-301a-461b-8028-096150205c20",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "06a4d504-d0d6-4476-9c4c-5d193be9682f",
      "ContentItemId": "31775d77-f752-4cc5-af6e-dfbf0fc6746e",
      "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-19T01:12:39.0624185+00:00",
      "RescheduleDate": "2025-11-19T01:12:39.0624185+00:00"
    },
    {
      "Id": "06a4d504-d0d6-4476-9c4c-5d193be9682f",
      "ContentItemId": "31775d77-f752-4cc5-af6e-dfbf0fc6746e",
      "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-19T01:12:39.0624185+00:00",
      "RescheduleDate": "2025-11-19T01:12:39.0624185+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}