Skip to main content

GET Questionnaire

Questionnaires are completed by the customer after they order a test kit and before they register the test kit. Requesting questionnaires is optional when customers use their own care team to manage queries.

Get questions and possible answers, by testKitCode and gender.

Request

Response

Request

Endpoint

GET {clientId}/api/v1/questionnaires/{testKitCode}?gender={genderName}

Path parameters

ParameterDescriptionTypeRequired/optional
clientIdThe Client ID is a unique code that is provided by LetsGetChecked.stringRequired
testKitCodeThe test kit code is a unique code that is provided by LetsGetChecked.stringRequired

Query parameters

ParameterDescriptionTypeRequired/optional
genderThe genderName can be specified as male or female.stringRequired

Body

<Empty>

Response

The sample response is a single JSON object that contains the following fields:

PropertyDescriptionType
questionsThe questions array contains all of the questions together with all of the possible answers.array of object(Question)
QuestionThe survey question.The Question can be one of the following types:
  • id, guid
  • text, string
  • shortenedText, string
  • questionType, type(QuestionType)
  • tooltip, string
  • choices, array of object(Choice)
QuestionTypesThe type of survey question.The QuestionTypes can be one of the following types:
  • NotSet
  • SingleSelect
  • MultiSelect
  • Input
  • ExternalLookup
ChoiceThe answer choice options for the question.The Choice can be one of the following types:
  • index, int
  • text, string
  • shortenedText, string
  • answerType, type(AnswerType)
  • supportingFieldType, type(SupportingFieldType)
  • supportingFieldText, string
  • supportingFieldDescription, string
  • symptomFlag, string
  • nextQuestionId, guid. If the value is null, it is the end of the questionnaire.
AnswerTypeThe type of answer that is available for the question.The AnswerType can be one of the following types:
  • NotSet
  • RadioButton
  • CheckBox
  • Date
  • DateTime
  • Weight
  • Height
  • Integer
  • Decimal
  • String
  • BloodPressure
  • CheckBoxNone
  • Lookup
  • HeartRate
  • RadioButtonWithItems
SupportingFieldTypeThe type of supporting field that is available.The SupportingFieldType can be one of the following types:
  • None
  • Date
  • Time
  • DateTime
  • Integer
  • Decimal
  • String
  • StringArray
Sample request
{
"questions":[
{
"id":"e5de7407-3c88-4923-bc62-74b45c19ec73",
"text":"What is your date of birth?",
"shortenedText":"Date of birth",
"questionType":"Input",
"tooltip":null,
"choices":[
{
"index":1,
"text":"",
"shortenedText":"",
"answerType":"Date",
"supportingFieldType":"None",
"supportingFieldText":null,
"supportingFieldDescription":null,
"symptomFlag":"False",
"nextQuestionId":"fc422870-41a5-488a-bef7-9c3db6f622a4"
}
]
},
{
"id":"fc422870-41a5-488a-bef7-9c3db6f622a4",
"text":"Are you a current smoker or a previous smoker?",
"shortenedText":"Smoke",
"tooltip":null,
"questionType":"SingleSelect",
"choices":[
{
"index":1,
"text":"No, I have never smoked regularly",
"shortenedText":"No",
"answerType":"RadioButton",
"supportingFieldType":"None",
"supportingFieldText":null,
"supportingFieldDescription":null,
"symptomFlag":"True",
"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"
},
{
"index":2,
"text":"Yes, I am a current smoker",
"shortenedText":"Yes",
"answerType":"RadioButton",
"supportingFieldType":"None",
"supportingFieldText":null,
"supportingFieldDescription":null,
"symptomFlag":"False",
"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"
},
{
"index":3,
"text":"Yes, I was a previous smoker",
"shortenedText":"Yes",
"answerType":"RadioButton",
"supportingFieldType":"None",
"supportingFieldText":null,
"supportingFieldDescription":null,
"symptomFlag":"False",
"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"
}
]
},
{
"Id":"dd94331c-de1d-4bf3-a890-6e855f520439",
"text":"What is your weight?",
"shortenedText":"Weight",
"tooltip":null,
"questionType":"Input",
"choices":[
{
"index":1,
"text":"",
"shortenedText":"",
"answerType":"Weight",
"supportingFieldType":"None",
"supportingFieldText":null,
"supportingFieldDescription":null,
"symptomFlag":"False",
"nextQuestionId":null
}
]
}
]
}