Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get Surveys - POST /attributes - http://api.spectrumsurveys.com/buyers/v1/attributes

...

Call this API to view the respondent's question text, condition codes, and condition code texts for unfamiliar qualification codes/condition codes.  Survey_localization is a required Query String parameter.

...

  • Qualifications are shared across surveyLocalizations on PureSpectrum.  For example, we use the same code for b2b employment in the US/English, that we use in Japanese Japan.
  • Condition codes when appropriate are also shared across localizations
  • A condition code may have different text across different localizations
  • Even though the codes may be the same, we represent these questions/answers using the appropriate language/localization
  • We only currently support 3 question types in this api call: Singlepunch, Singlepunch-alt, & Multipunch
    • singlepunch is presented as a dropdown.  Singlepunch-alt and Multipunch are shown in push-button form

HEADER Parameters


Parameter

Type

Required

Description

access-token

string

Yes

Token used to identify the authenticity of the user.

Response Parameters    


Parameter

Type

Description

Nullable

text

string

The text of the question asked to the respondent


descstringA description of the question that is asked of the respondent
catstringCategory name of the question that is asked of the respondent

type

integer

1=singlepunch (only one selection is allowed, presented in dropdown form)

2=singlepunch-alt (only one selection is allowed - presented in push button form)

3=multipunch (multiple selections are allowed, presented in push button form)

4=range (not currently supported)


localizationsenum

Contains the question text and their respective answer text and ID's


localizationstringLists what type of language code the answer needs to be in...
respIDstringThis needs to be included in the text and acts as a container for answers block
answersarrayIts acts a container for range of "buyer_answer_id's" and corresponding "answer_text's"
buyer_answer_idstringIt is the "answer_id" to the question raised by buyer
answer_teststringIt is the "answer_text" to the question raised by buyer
condition_codesarray

Contains the condition codes and condition code texts

crtd_onUTC Timestamp in milliseconds since Unix EpochTimestamp of when this attribute was createdmod_onUTC Timestamp in milliseconds since Unix EpochTimestamp of when this attribute was modified. This may include a change in text, addition or modification of condition codes. In case the mod_on has changed since your last sync, delete the qualification in your system and recreate it to prevent inconsistencies.


condition_codes Array

ParameterTypeDescriptionNullable
idstring

the condition code of the corresponding text. This will match the requisite condition codes in a survey's qualifications/quotas


textstringThe text of the answer presented to the respondent

...