food

Get the options collection for a specific scope

get/options/options_collection/{scope}

Path parameters

scopestring required

Response

successful operation

idnumber nullable

Example response

{
  "categories": [
    {
      "description": "Food's preparation",
      "id": "preparation",
      "label": "Preparation",
      "name": "preparation",
      "restrictions": [
        {
          "source_string": "xb: dairy = non-dairy",
          "target_id": "dairy.dairy",
          "target_value": "non-dairy"
        }
      ]
    }
  ],
  "id": 123,
  "options": [
    {
      "category_id": "preparation",
      "description": "Food's preparation method",
      "id": "preparation.method",
      "label": "Method",
      "name": "method",
      "restrictions": [
        {
          "source_string": "xb: dairy = non-dairy",
          "target_id": "dairy.dairy",
          "target_value": "non-dairy"
        }
      ]
    }
  ],
  "values": [
    {
      "description": "Food is raw",
      "id": "preparation.method:yes",
      "label": "Raw",
      "option_id": "preparation.method",
      "restrictions": [
        {
          "source_string": "xb: dairy = non-dairy",
          "target_id": "dairy.dairy",
          "target_value": "non-dairy"
        }
      ],
      "synonyms": [
        "uncooked"
      ],
      "value": "raw"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.