Versions Compared

Key

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

...

Parameter

Type

Required

Description

localization

string

Yes

Define the Country & Language combination for which you need the attribute's question/answer text returned

format

bool

Yes

Boolean field, set to true. This flag was previously used for compatibility, failure to include will exclude qualifications.


Response Parameters    

Parameter

Type

Description

Nullable

text

string

The text of the question asked to the respondent


desc

string

A description of the question that is asked of the respondent


cat

string

Category 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)



class

integer

1 = Core profiling question

2 = Extended profiling question

3 = Custom profiling question


condition_codes

array

contains the condition codes and condition code texts


crtd_on

UTC Timestamp in milliseconds since Unix Epoch

Timestamp of when this attribute was created


mod_on

UTC Timestamp in milliseconds since Unix Epoch

Timestamp 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.


...

Code Block
GET /suppliers/v2/attributes/1031?survey_localization=en_US&format=true
Host: api.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

...

Code Block
GET /suppliers/v2/attributes/1031?survey_localization=en_US&format=true
{
  "text":"Which of the following pets do you own?",
  "cat":"Pets",
  "desc":"Pet Ownership",
  "type":3,
  "class":2,
  "condition_codes":[
	{"id":"111","text":"Dog"},
	{"id":"112","text":"Cat"},
	{"id":"113","text":"Rabbit"},
	{"id":"114","text":"Snake/Lizard"},
	{"id":"115","text":"Fish"},
	{"id":"116","text":"Small Birds"},
	{"id":"117","text":"Large Birds"},
	{"id":"118","text":"Horse/Equine"},
	{"id":"119","text":"Ferrets"},
	{"id":"120","text":"Hamster or other Rodent"},
	{"id":"121","text":"Turtle"},
	{"id":"122","text":"Exotic Pets"},
	{"id":"999","text":"None of the Above"}
  ],
  "crtd_on": 1487871678958,
  "mod_on": 1487871678958
}

...

Code Block
GET /suppliers/v2/attributes/1034?survey_localization=en_US&format=true
{
  "text":"The company I work for employs approximately %1034% people",
  "cat":"B2B",
  "desc":"Company Size (Employees)",
  "type":1,
  "class":2,
  "condition_codes":[
	{"id":"111","text":"1 to 5"},
	{"id":"112","text":"6 to 9"},
	{"id":"113","text":"10 to 19"},
	{"id":"114","text":"20 to 24"},
	...
	{"id":"125","text":"50,000+"},
	{"id":"999","text":"Don't know"}
  ],
  "crtd_on": 1487871678958,
  "mod_on": 1487871678958
}

...

Code Block
GET /suppliers/v2/attributes/1040?survey_localization=en_US&format=true
{
  "text":"Are you registered in any of the following US political parties?",
  "cat":"Politics",
  "desc":"Political Party Affiliation",
  "type":1,
  "class":2,
  "condition_codes":[
	{"id":"111","text":"Democratic Party"},
	{"id":"112","text":"Republican Party"},
	{"id":"113","text":"Independent"},
	{"id":"114","text":"Constitution Party"},
	...
	{"id":"117","text":"Other"},
	{"id":"118","text":"I am not registered with a political party"}
  ],
  "crtd_on": 1487871678958,
  "mod_on": 1487871678958
}

...