POST api/v1/surveys/available

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	integer	None.
AppDeviceTypeID	integer	None.
NotificationID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "userId": 1,
  "appDeviceTypeID": 2,
  "notificationID": "sample string 3"
}

text/xml

Sample:

<AvailableSurveyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PMSBL.Entity">
  <AppDeviceTypeID>2</AppDeviceTypeID>
  <NotificationID>sample string 3</NotificationID>
  <UserId>1</UserId>
</AvailableSurveyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PSWebServicePanelistSurvey

Name	Type	Additional information
IsSessionExpired	boolean	None.
SurveyCount	integer	None.
CompletedSurveys	integer	None.
LearningCenterCredits	integer	None.
PanelistStatusId	integer	None.
Status	boolean	None.
Message	string	None.
HelpdeskEmailId	string	None.
StatusId	integer	None.
IsUserActive	boolean	None.
OTPInfo	string	None.
OTPInfoMessage	string	None.
CLI_Id	string	None.
Surveys	Collection of WSPanelistSurvey	None.
isOtpLimitExceeded	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "surveys": [
    {
      "endDate": "2025-01-21T23:39:25.1140334-05:00",
      "startTime": "2025-01-21T23:39:25.1140334-05:00",
      "points": 1,
      "surveyTitle": "sample string 2",
      "createdDate": "2025-01-21T23:39:25.1140334-05:00",
      "surveyLink": "sample string 3",
      "id": 4,
      "proposedTime": "2025-01-21T23:39:25.1140334-05:00",
      "projectname": "sample string 5",
      "completePoint": 6,
      "loi": 7
    },
    {
      "endDate": "2025-01-21T23:39:25.1140334-05:00",
      "startTime": "2025-01-21T23:39:25.1140334-05:00",
      "points": 1,
      "surveyTitle": "sample string 2",
      "createdDate": "2025-01-21T23:39:25.1140334-05:00",
      "surveyLink": "sample string 3",
      "id": 4,
      "proposedTime": "2025-01-21T23:39:25.1140334-05:00",
      "projectname": "sample string 5",
      "completePoint": 6,
      "loi": 7
    }
  ],
  "isOtpLimitExceeded": true,
  "isSessionExpired": true,
  "surveyCount": 1,
  "completedSurveys": 2,
  "learningCenterCredits": 3,
  "panelistStatusId": 1,
  "status": true,
  "message": "sample string 5",
  "helpdeskEmailId": "sample string 6",
  "statusId": 7,
  "isUserActive": true,
  "otpInfo": "sample string 9",
  "otpInfoMessage": "sample string 10",
  "clI_Id": "sample string 11"
}

text/xml

Sample:

<PSWebServicePanelistSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PMSBL.Entity">
  <_Message>sample string 5</_Message>
  <_Status>true</_Status>
  <_helpdeskEmailId>sample string 6</_helpdeskEmailId>
  <_isUserActive>true</_isUserActive>
  <_statusId>7</_statusId>
  <_x003C_CLI_Id_x003E_k__BackingField>sample string 11</_x003C_CLI_Id_x003E_k__BackingField>
  <_x003C_OTPInfoMessage_x003E_k__BackingField>sample string 10</_x003C_OTPInfoMessage_x003E_k__BackingField>
  <_x003C_OTPInfo_x003E_k__BackingField>sample string 9</_x003C_OTPInfo_x003E_k__BackingField>
  <isOtpLimitExceeded>true</isOtpLimitExceeded>
  <Surveys>
    <WSPanelistSurvey>
      <_Points>1</_Points>
      <_StartTime i:nil="true" />
      <_SurveyLink>sample string 3</_SurveyLink>
      <_SurveyTitle>sample string 2</_SurveyTitle>
      <_x003C_CompletePoint_x003E_k__BackingField>6</_x003C_CompletePoint_x003E_k__BackingField>
      <_x003C_CreatedDate_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_CreatedDate_x003E_k__BackingField>
      <_x003C_EndDate_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_EndDate_x003E_k__BackingField>
      <_x003C_Id_x003E_k__BackingField>4</_x003C_Id_x003E_k__BackingField>
      <_x003C_Loi_x003E_k__BackingField>7</_x003C_Loi_x003E_k__BackingField>
      <_x003C_Projectname_x003E_k__BackingField>sample string 5</_x003C_Projectname_x003E_k__BackingField>
      <_x003C_ProposedTime_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_ProposedTime_x003E_k__BackingField>
      <_x003C_StartTime_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_StartTime_x003E_k__BackingField>
    </WSPanelistSurvey>
    <WSPanelistSurvey>
      <_Points>1</_Points>
      <_StartTime i:nil="true" />
      <_SurveyLink>sample string 3</_SurveyLink>
      <_SurveyTitle>sample string 2</_SurveyTitle>
      <_x003C_CompletePoint_x003E_k__BackingField>6</_x003C_CompletePoint_x003E_k__BackingField>
      <_x003C_CreatedDate_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_CreatedDate_x003E_k__BackingField>
      <_x003C_EndDate_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_EndDate_x003E_k__BackingField>
      <_x003C_Id_x003E_k__BackingField>4</_x003C_Id_x003E_k__BackingField>
      <_x003C_Loi_x003E_k__BackingField>7</_x003C_Loi_x003E_k__BackingField>
      <_x003C_Projectname_x003E_k__BackingField>sample string 5</_x003C_Projectname_x003E_k__BackingField>
      <_x003C_ProposedTime_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_ProposedTime_x003E_k__BackingField>
      <_x003C_StartTime_x003E_k__BackingField>2025-01-21T23:39:25.1140334-05:00</_x003C_StartTime_x003E_k__BackingField>
    </WSPanelistSurvey>
  </Surveys>
  <_x003C_CompletedSurveys_x003E_k__BackingField>2</_x003C_CompletedSurveys_x003E_k__BackingField>
  <_x003C_IsSessionExpired_x003E_k__BackingField>true</_x003C_IsSessionExpired_x003E_k__BackingField>
  <_x003C_LearningCenterCredits_x003E_k__BackingField>3</_x003C_LearningCenterCredits_x003E_k__BackingField>
  <_x003C_PanelistStatusId_x003E_k__BackingField>1</_x003C_PanelistStatusId_x003E_k__BackingField>
  <_x003C_SurveyCount_x003E_k__BackingField>1</_x003C_SurveyCount_x003E_k__BackingField>
</PSWebServicePanelistSurvey>