Get company question

Get company question
deprecated

Request

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

questionIdstring, (uuid)required

Identifier for question.

Example:1234a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/questions/1234a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

idstring, (uuid)required

namestringrequired

Question display name that the user will see. For eg, 'Choose the purpose of your trip'.

questionFormatstring(QuestionFormat)

Question types. INPUT_BOX will make user enter a free flowing text. RADIO_BUTTON will have multiple options, user can select only one. CHECKBOX questions contain the possible set of options, from which the user can choose multiple options. CHECKBOX_WITH_PERCENTAGE is similar to checkbox, with the difference being that each option having an additional input field whose values must add up to 100.

Enum:"INPUT_BOX""RADIO_BUTTON""CHECKBOX""CHECKBOX_WITH_PERCENTAGE"

Example:"CHECKBOX"

optionInfoobject(OptionInfo)

Options related information for the question.

isRequiredbooleanrequired

Whether its compulsory to answer the question or not.

Default:false

Example:true

isDisabledbooleanrequired

Whether the question is disabled or not. If true, this should not be asked.

Default:true

Example:true

customFieldLocationsArray of strings

matchConditionsobject(CustomFieldMatchConditions)

Conditions to select the custom field for given context.

questionTypeobject(QuestionType)

Question type.

includeInItinerarybooleandeprecated

Whether to include this question in the itinerary related emails.

Default:false

Example:true

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "questionFormat": "CHECKBOX",
  "optionInfo": {
    "source": "MANUAL",
    "sourceMetadata": { … },
    "totalNumOptions": 0,
    "options": [ … ]
  },
  "isRequired": true,
  "isDisabled": true,
  "includeInItinerary": true,
  "customFieldLocations": [
    "POLICY_APPROVAL_EMAIL"
  ],
  "matchConditions": {
    "travelerConditions": { … },
    "travelTypes": [ … ],
    "travelRegionTypes": [ … ],
    "tripUsageTypes": [ … ]
  },
  "questionType": {
    "preSearchQuestionType": "PURPOSE_OF_TRIP",
    "preCheckoutQuestionType": "OOP_REASON_CODE"
  }
}