POST /attributes - http://api.spectrumsurveys.com/buyers/v1/attributes
GET /attributes - http://api.spectrumsurveys.com/buyers/v1/attributes/:buyer_attribute_id
...
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.
...
| Parameter | Type | Description | Nullable |
|---|---|---|---|
| id | string | the condition code of the corresponding text. This will match the requisite condition codes in a survey's qualifications/quotas | |
| text | string | The text of the answer presented to the respondent |
Sample
...
Buy API Request
| Code Block |
|---|
GETPOST /suppliersbuyers/v2v1/attributes/1031?survey_localization=en_US Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Sample API Response
Example 1: The attribute API POST request
| Code Block |
|---|
POST /buyers/v1/attributes/ { "buyer_attribute_id":"ABC123", "desc":"Pet Food Preferences", "category":"Pets", "type":1, //singlepunch "localizations":[ { "localization" : "en_US", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "text" : "Not Sure/Doesn't Apply" } ] }, { "localization" : "en_CA", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "text" : "Not Sure/Doesn't Apply" } ] } } |
...
Sample API Response
| Code Block |
|---|
{
"ps_qualification_code" : 1110
"buyer_attribute_id" : "ABC123",
"desc" : "Pet Food Preferences",
"Category" : "Pets",
"type":1,
"localizations":[
{
"localization" : "en_US",
"text": "Do you purchase dry or wet Dog Food?%%respID%%"
"answers":[
{
"buyer_answer_id" : "DEF456-1",
"ps_cond_code":"111"
"text" : "Dry Food"
},
{
"buyer_answer_id" : "DEF456-2",
"ps_cond_code":"112"
"text" : "Wet Food"
},
{
"buyer_answer_id" : "DEF456-99",
"ps_cond_code":"113"
"text" : "Not Sure/Doesn't Apply"
}
]
},
{
"localization" : "en_CA",
"text": "Do you purchase dry or wet Dog Food?%%respID%%"
"answers":[
{
"buyer_answer_id" : "DEF456-1",
"ps_cond_code":"111"
"text" : "Dry Food"
},
{
"buyer_answer_id" : "DEF456-2",
"ps_cond_code":"112"
"text" : "Wet Food"
},
{
"buyer_answer_id" : "DEF456-99",
"ps_cond_code":"113"
"text" : "Not Sure/Doesn't Apply"
}
]
}
]
}
|
Example 2 : The attribute API Response
| Code Block |
|---|
GET /buyers/v1/attributes/ABC123 Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx { "ps_qualification_code" : 1110 "buyer_attribute_id" : "ABC123", "desc" : "Pet Food Preferences", "Category" : "Pets", "type":1, "localizations":[ { "localization" : "en_US", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "ps_cond_code":"111" "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "ps_cond_code":"112" "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "ps_cond_code":"113" "text" : "Not Sure/Doesn't Apply" } ] }, { "localization" : "en_CA", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "ps_cond_code":"111" "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "ps_cond_code":"112" "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "ps_cond_code":"113" "text" : "Not Sure/Doesn't Apply" } ] } ] } |
HTTP Response Codes
Response | Status | Description |
|---|---|---|
200 | OK | |
| 400 | Bad Request | See Error Messages |
| 404 | Not Found | Qualification code doesn't exist in database |
5xx | Internal Server Error | Please Report to support@purespectrum.com |
...