Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Get Surveys - GET /surveys - http://api.spectrumsurveys.com/suppliers/v2/surveys


Call this API to view surveys that your Supplier account has an allocation for.  You are expected to Register Intent & send sample to these surveys.  

You can use this method to check the status of existing surveys you are delivering on, including current LOI, IR, & CPI.


HEADER Parameters

Parameter

Type

Required

Description

access-token

string

Yes

Token used to identify the authenticity of the user.



Response Parameters    

Parameter

Type

Description

quota_id

integer

Quota ID

Criteria

Object

Contains Qualification codes and their corresponding condition codes

qualification_code

integer

218 for Children , 220 fro Kid's Gender and 230 for Kid's age.

condition_codesintegerFor 218, 111 stands for No children and 112 for having children.


Sample API Request

GET /suppliers/v2/surveys/
Host: api.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


Sample API Response

"quotas": [

{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":

                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },

           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "111"
                          ]
                  },
                  {
                        "qualification_code": 220,
                        "condition_codes": [
                              "111"
                         ]
                  },
                  {
                        "qualification_code": 230,
                        "range_sets": [
                                 {
                                       "units": 311,
                                       "to": 1,
                                       "from": 1
                                 }
                         ]
                  }

                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

  • No labels