Respondent Pre Survey Check

Production Endpoint

https://supplier.innovatemr.net/api/v2

POST

/supply/respondentPreSurveyCheck

This endpoint allows Suppliers to check if a respondent will able to qualify the survey or not before actualy sending them to the innovate platform.

Response

status

"prequalified" - respondent satisfies the available pre-survey validations and ready to participate on the survey.

"disqualified" - respondent did not satisfy 1+ of the pre-survey validations and NOT ready to participate on the survey.

disqualification

[ <array/list of term reason categories - string> ]

Example

if the respondent trips the GEOIP validation “GEOIP” will be included in the disqualifications list. Additionally, if the survey N has been achieved, "OpportunityFull” would be included in the disqualifications list.

Request

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Body Params application/json

pid

string

required

string

required

survNum

integer

required

deviceType

string

required

Example

{
    "pid": "string",
    "ip": "string",
    "survNum": 0,
    "deviceType": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://supplier.innovatemr.net/api/v2/supply/respondentPreSurveyCheck' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pid": "string",
    "ip": "string",
    "survNum": 0,
    "deviceType": "string"
}'

Responses

🟢200OK

application/json

Body

apiStatus

string

required

msg

string

required

result

object

required

status

string

required

disqualification

string

required

Example

{
    "apiStatus": "string",
    "msg": "string",
    "result": {
        "status": "string",
        "disqualification": "string"
    }
}

get surveys for respondent

Single Term Reason Category Code