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

Name	Description	Type	Additional information
userIdentifier	user's identifier	PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier	Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.View.UserStateViewModel

Name	Type	Additional 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": "360ae96f-abf8-453c-80c4-9cbc8be6a556",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2024-10-05T09:21:03.2377104+00:00",
  "Registration": [
    {
      "Id": "07c2b413-c156-4c39-a028-0b3c648ada75",
      "UserId": "e3a86ade-6c69-4183-a137-0636c859b246",
      "IsCurrent": true,
      "CenterId": "8fd6058c-c9f5-4695-8590-fe9e5b69c998",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1d2a45bb-0ead-4899-aa26-5c1f67d17a60",
      "EndDate": "2024-10-05T09:21:03.2220841+00:00",
      "StartDate": "2024-10-05T09:21:03.2220841+00:00",
      "SchedulePreferenceDate": "2024-10-05T09:21:03.2220841+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
    },
    {
      "Id": "07c2b413-c156-4c39-a028-0b3c648ada75",
      "UserId": "e3a86ade-6c69-4183-a137-0636c859b246",
      "IsCurrent": true,
      "CenterId": "8fd6058c-c9f5-4695-8590-fe9e5b69c998",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1d2a45bb-0ead-4899-aa26-5c1f67d17a60",
      "EndDate": "2024-10-05T09:21:03.2220841+00:00",
      "StartDate": "2024-10-05T09:21:03.2220841+00:00",
      "SchedulePreferenceDate": "2024-10-05T09:21:03.2220841+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
    }
  ],
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2024-10-05T09:21:03.2220841+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "69cc896b-d684-423c-af81-b3c76f8402d1",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "6c2a5fac-693d-42b8-b3b9-da5d20c6fff3",
      "Sequence": 1,
      "AncestorCategoryId": "e14f1a4e-27d3-41df-8de6-9f12f62014aa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "69cc896b-d684-423c-af81-b3c76f8402d1",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "6c2a5fac-693d-42b8-b3b9-da5d20c6fff3",
      "Sequence": 1,
      "AncestorCategoryId": "e14f1a4e-27d3-41df-8de6-9f12f62014aa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "babc5db7-038c-46a3-9fdf-de0860d3091a",
    "CategoryId": "4c88081b-f10c-4a30-b1c4-ec0087535f01",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "99de8c7e-8a8a-410e-9c93-e49176179eba",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "99de8c7e-8a8a-410e-9c93-e49176179eba",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "77536ecf-e447-49e9-91bd-06cae58de635",
      "Questions": [
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        },
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "77536ecf-e447-49e9-91bd-06cae58de635",
      "Questions": [
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        },
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8fed83e5-94f8-4feb-bdbe-5f6fbff0902b",
      "ContentItemId": "6d8291e3-9890-4813-8c3e-61a5b526ba15",
      "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": "2024-10-05T09:21:03.2220841+00:00",
      "RescheduleDate": "2024-10-05T09:21:03.2220841+00:00"
    },
    {
      "Id": "8fed83e5-94f8-4feb-bdbe-5f6fbff0902b",
      "ContentItemId": "6d8291e3-9890-4813-8c3e-61a5b526ba15",
      "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": "2024-10-05T09:21:03.2220841+00:00",
      "RescheduleDate": "2024-10-05T09:21:03.2220841+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:

{
  "UserId": "360ae96f-abf8-453c-80c4-9cbc8be6a556",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2024-10-05T09:21:03.2689577+00:00",
  "Registration": [
    {
      "Id": "07c2b413-c156-4c39-a028-0b3c648ada75",
      "UserId": "e3a86ade-6c69-4183-a137-0636c859b246",
      "IsCurrent": true,
      "CenterId": "8fd6058c-c9f5-4695-8590-fe9e5b69c998",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1d2a45bb-0ead-4899-aa26-5c1f67d17a60",
      "EndDate": "2024-10-05T09:21:03.2220841+00:00",
      "StartDate": "2024-10-05T09:21:03.2220841+00:00",
      "SchedulePreferenceDate": "2024-10-05T09:21:03.2220841+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
    },
    {
      "Id": "07c2b413-c156-4c39-a028-0b3c648ada75",
      "UserId": "e3a86ade-6c69-4183-a137-0636c859b246",
      "IsCurrent": true,
      "CenterId": "8fd6058c-c9f5-4695-8590-fe9e5b69c998",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1d2a45bb-0ead-4899-aa26-5c1f67d17a60",
      "EndDate": "2024-10-05T09:21:03.2220841+00:00",
      "StartDate": "2024-10-05T09:21:03.2220841+00:00",
      "SchedulePreferenceDate": "2024-10-05T09:21:03.2220841+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
    }
  ],
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2024-10-05T09:21:03.2220841+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "69cc896b-d684-423c-af81-b3c76f8402d1",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "6c2a5fac-693d-42b8-b3b9-da5d20c6fff3",
      "Sequence": 1,
      "AncestorCategoryId": "e14f1a4e-27d3-41df-8de6-9f12f62014aa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "69cc896b-d684-423c-af81-b3c76f8402d1",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "6c2a5fac-693d-42b8-b3b9-da5d20c6fff3",
      "Sequence": 1,
      "AncestorCategoryId": "e14f1a4e-27d3-41df-8de6-9f12f62014aa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "d1de911c-9235-48ab-a727-36f007836ac2",
          "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": "babc5db7-038c-46a3-9fdf-de0860d3091a",
    "CategoryId": "4c88081b-f10c-4a30-b1c4-ec0087535f01",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "99de8c7e-8a8a-410e-9c93-e49176179eba",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "99de8c7e-8a8a-410e-9c93-e49176179eba",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "77536ecf-e447-49e9-91bd-06cae58de635",
      "Questions": [
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        },
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "77536ecf-e447-49e9-91bd-06cae58de635",
      "Questions": [
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        },
        {
          "Id": "40d18768-faed-40be-9b23-6551feb2d858",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8fed83e5-94f8-4feb-bdbe-5f6fbff0902b",
      "ContentItemId": "6d8291e3-9890-4813-8c3e-61a5b526ba15",
      "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": "2024-10-05T09:21:03.2220841+00:00",
      "RescheduleDate": "2024-10-05T09:21:03.2220841+00:00"
    },
    {
      "Id": "8fed83e5-94f8-4feb-bdbe-5f6fbff0902b",
      "ContentItemId": "6d8291e3-9890-4813-8c3e-61a5b526ba15",
      "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": "2024-10-05T09:21:03.2220841+00:00",
      "RescheduleDate": "2024-10-05T09:21:03.2220841+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}