QuestionnaireOverviewData

The questionnaire overview contains basic information about the questionnaire.

Overview data doesn’t contains questions and answers.

Properties

Key

string

Key of the questionnaire.

Name

string

Name of the questionnaire.

Description

string

Description of the questionnaire.

StatusCode

int

Status code of the questionnaire:

  • 0 = Incomplete
  • 1 = Complete
  • 2 = Partially Complete

Status

string

String representation of the status code.

AppointmentKey

string

The appointment the questionnaire is for.

Expiration

DateTime

When the questionnaire expires.

Sent

DateTime (optional)

When the questionnaire was sent.

ReferralKey

string (optional)

If present, the key of a referral that was created from the questionnaire request.

CanRefer

bool (optional)

Whether the questionnaire indicates a referral.

JSON Example

{
    "Key": "q13788",
    "Name": "Basic questionnaire",
    "Description": "",
    "StatusCode": 0,
    "Status": "Incomplete",
    "AppointmentKey": "apt5821",
    "Expiration": "2013-08-25",
    "Sent": "2013-07-01",
    "ReferralKey": "8ebb55f10382d73e494e7207d1bd7272",
    "CanRefer": 0
}