Get an indication survey

GET

/prescription/survey/{lang}/{idIndicationSurvey}

curl --request GET \
  --url https://client-api.abi.ai/prescription/survey/en/42 \
  --header 'Authorization: Bearer <token>'

• Abi Client API

Retrieve the questions, choices, and exit logic for one indication survey in the requested language.

Authorizations

• bearerAuth

Parameters

Path Parameters

lang

required

string

Example

en

idIndicationSurvey

required

string

Indication-survey identifier returned by the survey list.

Example

42

Responses

200

The selected indication survey returned in the requested language, including its questions and choices.

Media typeapplication/json

object

id

string

category

string

isRefill

boolean

title

string

order

integer

questions

Localized survey questions and their available choices.

Array<object>

object

id

integer

title

string

description

string

type

string

Allowed values: single_choice open_ended

displayPosition

string

isRequired

boolean

order

integer

choices

Array<object>

object

id

integer

text

string

indicationSurveyQuestionId

integer

isExitLogic

boolean

order

integer

Example

{
  "id": "92",
  "category": "Digestive Health",
  "isRefill": false,
  "title": "Indigestion Survey",
  "order": 0,
  "questions": [
    {
      "id": 610,
      "title": "Do you experience bloating after meals?",
      "description": "Tell us about your symptoms.",
      "type": "single_choice",
      "displayPosition": "vertical",
      "isRequired": true,
      "order": 1,
      "choices": [
        {
          "id": 701,
          "text": "Yes",
          "indicationSurveyQuestionId": 610,
          "isExitLogic": false,
          "order": 1
        }
      ]
    }
  ]
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}