Versions Compared

Key

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

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

...

Warning

In case targeting is present on either age of child or gender of child, a nested quota will be present containing age of child, gender of child, and parent qualification codes. (218, 220, 230). 


HEADER Parameters

Parameter

Type

Required

Description

access-token

string

Yes

Token used to identify the authenticity of the user.

...

Code Block
Example 1: quota is looking for parents of 1 year old boy.

"quotas": [
{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":
                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },
           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "112"
                          ]
                  },
                  {
                        "qualification_code": 220,
                        "condition_codes": [
                              "111"
                         ]
                  },
                  {
                        "qualification_code": 230,
                        "range_sets": [
                                 {
                                       "units": 311,
                                       "to": 1,
                                       "from": 1
                                 }
                         ]
                  }
                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

Example 2: quota is looking for people who are *not* parents

"quotas": [
{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":
                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },
           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "111"
                          ]
                  }
                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

Example 2: quota is looking for people who are parents of boy or girl 3 months - 18 months

"quotas": [
{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":
                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },
           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "112"
                          ]
                  },
                  {
                        "qualification_code": 220,
                        "condition_codes": [
                              "111",
							  "112"
                         ]
                  },
                  {
                        "qualification_code": 230,
                        "range_sets": [
                                 {
                                       "units": 312,
                                       "to": 18,
                                       "from": 3
                                 }
                         ]
                  }
                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

Example 3: quota is looking for people who are parents of child a boy with age between 3 months - 18 months

"quotas": [
{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":
                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },
           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "112"
                          ]
                  },
                  {
                        "qualification_code": 220,
                        "condition_codes": [
                              "111"
                         ]
                  },
                  {
                        "qualification_code": 230,
                        "range_sets": [
                                 {
                                       "units": 312,
                                       "to": 18,
                                       "from": 3
                                 }
                         ]
                  }
                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

Example 4: quota is looking for people who are parents of a boy with age between 1 year - 18 years

"quotas": [
{
          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
          "quantities":
                 {
                       "currently_open": 100,
                       "remaining": 100,
                       "achieved": 0
                  },
           "criteria": [
                  {
                        "qualification_code": 218,
                        "condition_codes": [
                              "112"
                          ]
                  },
                  {
                        "qualification_code": 220,
                        "condition_codes": [
                              "111"
                         ]
                  },
                  {
                        "qualification_code": 230,
                        "range_sets": [
                                 {
                                       "units": 311,
                                       "to": 18,
                                       "from": 1
                                 }
                         ]
                  }
                 ],
               "crtd_on": 1505724120171,
               "mod_on": 1505724120171
}
]

...