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": {
"id": "32",
"title": "MPAs and Certified Sustainable Small-scale Fisheries",
"url": "http://panorama.tbo/en/solution/mpas-and-certified-sustainable-small-scale-fisheries",
"wdpa": 123456,
"field_location": "Bejuco, Nicoya, Costa Rica",
"field_location_geofield": "{\"type\":\"Point\",\"coordinates\":[-85.45,10.15]}",
"country_name": "France",
"country_iso_2": "FR",
"preview_image": {
"src": "http://panorama.tbo/sites/default/files/styles/x-large/public/Pretoma_Data_collection.jpg?itok=Dhie36Uf",
"alt": "A. Bystrom",
"title": "Data collection.",
"width": "780",
"height": "585"
},
"thumbnail": {
"src": "https://panoramatest.tbodev.de/sites/default/files/styles/medium/public/uicn_orlu_snapshot_sol_2_photo1.jpg?itok=a3zg1iN_",
"alt": "ONCFS",
"title": "Sedum candollei",
"width": "220",
"height": "165"
},
"summary": "<p>some text... </p>",
"impacts": "<p>some text... </p>",
"story": "<p>some text... </p>",
"building_blocks": [
{
"building_block": {
"title": "Catch Composition Data Collection and Analysis",
"url": "http://panorama.tbo/en/building-block/catch-composition-data-collection-and-analysis"
}
},
{
"building_block": {
"title": "Artisanal Snapper Fishery Management Plan",
"url": "http://panorama.tbo/en/building-block/artisanal-snapper-fishery-management-plan"
}
},
{
"building_block": {
"title": "Development of multi-use MPAs ",
"url": "http://panorama.tbo/en/building-block/development-multi-use-mpas"
}
},
{
"building_block": {
"title": "International Sustainability Certification",
"url": "http://panorama.tbo/en/building-block/international-sustainability-certification"
}
},
{
"building_block": {
"title": "Alternative markets for high quality fish",
"url": "http://panorama.tbo/en/building-block/alternative-markets-certified-fish"
}
}
],
"contributors": [
{
"contributor": {
"name": "Andy Bystrom",
"organisation": "Asociación Red Costarricense para el Ambiente y la Educación (ARCAE)"
}
}
],
"organizations_involved": [
{
"organization": {
"name": "Asociación Red Costarricense para el Ambiente y la Educación (ARCAE)",
"url": "http://panorama.tbo/en/organisation/asociacion-red-costarricense-para-el-ambiente-y-la-educacion-arcae"
}
},
{
"organization": {
"name": "Endangered Marine Species Rescue Center (CREMA)",
"url": "http://panorama.tbo/en/organisation/endangered-marine-species-rescue-center-crema"
}
}
]
}
}
]
}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 |
|---|---|---|
| id | string | The unique id of a Solution |
| title | string | The title of the solution. |
| field_location | string | Describes the location area |
| field_location_geofield | GEOJSON | Contains coordinates of the solution |
| country_name | String | Country Name in english |
| country_iso_2 | String | Country Name in ISO2 Format |
| wdpa | string | Contains the id of the protectedplanet.net Project. Will return null if not given. |
| 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 |
| thumbnail | object | An object holding the fields for a thumbnail image |
| src | string | Field of "preview_image" and "thumbnail": the URL to the image file |
| alt | string | Field of "preview_image" and "thumbnail": the alt attribute value |
| title | string | Field of "preview_image" and "thumbnail": the title attribute value |
| width | string | Field of "preview_image" and "thumbnail": the width value of the image (without px) |
| height | string | Field of "preview_image" and "thumbnail": 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:
|
| 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:
|
| 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:
|