login v1.0

Endpoint URL

https://endpoint/login

Request Body Parameters

Parameter	Data Type	Optional/Mandatory	Default if not specified	Constraints	Description
username	String	Mandatory	N/A - Mandatory Parameter	Must be a valid username within your account	The username of an active user within your account having the Data Viewer and API User roles.
password	String	Mandatory	N/A - Mandatory Parameter	Must be the current password on your account	The password for your API user.
apiKey	String	Mandatory	N/A - Mandatory Parameter	Must be a valid API Key generated from QuickTapSurvey	A valid API key for your account. You can get an API by contacting our support team.

Response Parameters

resultCode	String	A code corresponding to the result of the request. See result code explanations.
resultDescription	String	A description of the result of the login request.

Sample JSON Request

{

"username": "myapiusername",

"password": "mysecretpassword",

"apiKey": "AS3345FGHDFG"

}

Sample JSON Response

{

  "resultCode": "10",

  "resultDescription": "Login succeeded."

}