Application API Search questions

#/searches/questions [GET]

Retrieve Search Criteria (Label/Value pairs) - protected.

Returns both basic and platinum search criteria, with labels/values localized.

Age and location criteria are not included since those are always available.

Parameters

none

Response Messages

200 OK - success

The response includes basic, platinum, and matches (My Match) search criteria which are gendered for the current member, and basic_other, platinum_other, and matches_other which are gendered for the current member’s preference. The latter should be used when the member is setting up searches on other members.

{
  "basic" : [

Each group (basic, platinum, matches, and the _other variants) contains an array of search criteria structures. Each criteria has a localized label, a field name, and an array of localized and actual values:

    { "label" : "Physique",
      "name" : "build",
      "values" : [

If the values array is empty, it indicates a free text field (we currently have very few of these), and the corresponding search criterion (for POST /searches) should use value (a single value). Otherwise the array provides pairs of localized label and value that can be shown in a multi-select drop-down or set of check boxes, and the corresponding search criterion should use values (even for a single value).

        { "label" : "...",
          "value" : "..." },
        { "label" : "...", "value" : "..." },
        ...
      ] },
    { "label" : "...", "name" : "...", "values" : [] },
    ...
  ],
  "platinum" : [
    { "label" : "...", "name" : "...", "values" : [ ... ] },
    ...
  ],
  "matches" : [
    { "label" : "...", "name" : "...", "values" : [ ... ] },
    ...
  ],
  "basic_other" : [
    { "label" : "...", "name" : "...", "values" : [ ... ] },
    ...
  ],
  "platinum_other" : [
    { "label" : "...", "name" : "...", "values" : [ ... ] },
    ...
  ],
  "matches_other" : [
    { "label" : "...", "name" : "...", "values" : [ ... ] },
    ...
  ]
}

Note: certain criteria have additional restrictions placed on them that are not reflected in the values list. For example, within lists distances and not all of those are available to basic (non-subscriber) members.