QuickTapSurvey Support Center

listSurveys v1.0

Endpoint URL 

https://endpoint/listSurveys 

Request Body Parameters

 Parameter

Data Type

 Optional/Mandatory

 Default if not specified

 Constraints

 Description

pageSize

int

Optional

100

Min 1, Max 1000

The number of results to be returned in the current request or page.

pageNumber

int

Optional

1

Min 1

The page number of the result set being returned.

 

Response Parameters

pageNumber

int

The page number of the result set being returned.

surveyList

array

A list of surveys that you are authorized to access. Each survey inside this list contains a surveyId, surveyName, and totalResponses field.

surveyId

int

The integer that uniquely identifies a survey.

surveyName

String

The name of the survey.

totalResponses

int

The number of responses that have been collected for the survey from active devices.

resultCode

String

A code corresponding to the result of the request. See result code explanations.

resultDescription

String

A description of the result of the API request.

 

Sample JSON Request

{

pageSize: 25,

pageNumber: 1

}

  

Sample JSON Response

{

pageNumber: 1,

surveyList: [

{

surveyId: 38064,

surveyName: "Api Test Data",

totalResponses: 7

}

],

resultCode: "20",

resultDescription: "List surveys succeeded."

}

 

       

Powered by HelpSite