Primary tabs

Here you find a sample response with results, with no results and with errors. Additionally you find a table describing the field of the JSON object in the response in some more details.

Sample API response with results

If the response delivers any solutions to you the JSON object consists of a "solutions" array in which each solution is added as a object "solution" which has all the fields for each solution.

{
  "solutions": [
    {
      "solution": {
        "title": "This is an example title",
        "field_location": "Maya Mountain North Forest Reserve, Toledo, Belize",
        "field_location_geofield": "{"type":"Point","coordinates":[-88.924338,16.286229]}",
        "url": "https://panorama.solutions/en/solution/path-of-example-solution",
        "preview_image": {
          "src": "https://panorama.solutions/sites/default/files/styles/x-large/public/tbo_factory.png?itok=-w7duwir",
          "alt": "Alt of image",
          "title": "Title of image",
          "width": "780",
          "height": "439"
        },
        "summary": "<p>The summary the solution provider described.</p><p>It may ínclude some HTML markup like paragraphs and lists and can be null (but never should)</p>",
        "impacts": "<p>The impacts the solution provider described.</p><p>It may ínclude some HTML markup like paragraphs and lists and can be null (but never should)</p>",
        "story": "<p>The story the solution provider described.</p><p>It may ínclude some HTML markup like paragraphs and lists and can be null</p>",
         "building_blocks": [
          {
            "building_block": {
              "title": "The title of building block number 1",
              "url": "https://panorama.solutions/en/building-block/building-block-example-1"
            }
          },
          {
            "building_block": {
              "title": "The title of building block number 2",
              "url": "https://panorama.solutions/en/building-block/building-block-example-2"
            }
          },
          {
            "building_block": {
              "title": "The title of building block number 3",
              "url": "https://panorama.solutions/en/building-block/building-block-example-3"
            }
          }
        ],
        "contributors": [
          {
            "contributor": {
              "name": "Name of contributor 1",
              "organisation": "Organisation name of contributor 1"
            }
          }
        ],
        "organizations_involved": [
          {
            "organization": {
              "name": "Name of Organisation",
              "url": "https://panorama.solutions/en/organisation/path-to-profile-on-panorama"
            }
          }
        ]
      }
    }
  ]
}

Sample API response with no results

{
  "solutions": []
}

Sample API response with error

{
  "error": "Description of the error which appeared"
}

Table of fields within the JSON object

Field in JSON Type Information
title string The title of the solution.
field_location string Describes the location area
field_location_geofield GEOJSON Contains coordinates of the solution
url string The URL on Panorama to the detail page of the solution.
preview_image object An object holding the fields for a preview image we deliver to you
src string Field of "preview_image": the URL to the image file
alt string Field of "preview_image": the alt attribute value
title string Field of "preview_image": the title attribute value
width string Field of "preview_image": the width value of the image (without px)
height string Field of "preview_image": the height value of the image (without px)
summary string A summary describing what the solution is and how it is being applied. Includes HTML markup.
impacts string Describes the demonstrated positive impacts of the solution including environmental, social and economic impacts.
Includes HTML markup.
story string|null Illustrates the solution by providing an inspiring, personal story of the solution in action. Includes HTML markup, can be null.
building_blocks array An array of building blocks belonging to this solution. Building blocks are the core components of a solution such as instruments, tools, approaches, partnerships or processes that could be applied in other contexts.

Each array element within "building_blocks" is an object "building_block" which has the following fields:
  • "title" - string, the title of the building block
  • "url" - string, the URL to the building block's detail page on Panorama
contributors array An array of people who contributed to this solution.

Each array element within "contributors" is an object "contributor" which has the following fields:
  • "name" - string, the name of the person
  • "organisation" - string, the name of the organisation the person belongs to
organisations_involved array An array of organisations which were involved in this solutions.

Each array element within "organisations_involved" is an object "organisation" which has the following fields:
  • "name" - string, the name of the person
  • "url" - string, an URL to the organisation's profile page on Panorama