{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/ecosystem","auth":"required","method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/ecosystem?limit=1 |  jq ."}]},"results":{"codes":[{"name":"","code":"{\n  \"count\": 143093,\n  \"returned\": 1,\n  \"data\": [\n    {\n      \"autoctr\": 1,\n      \"E_CODE\": 1,\n      \"EcosystemRefno\": 50628,\n      \"Speccode\": 549,\n      \"Stockcode\": 565,\n      \"Status\": \"native\",\n      \"Abundance\": null,\n      \"LifeStage\": \"adults\",\n      \"Remarks\": null,\n      \"Entered\": 1,\n      \"Dateentered\": \"2007-11-12T00:00:00.000Z\",\n      \"Modified\": 949,\n      \"Datemodified\": \"2007-11-12T00:00:00.000Z\",\n      \"Expert\": 949,\n      \"Datechecked\": null,\n      \"WebURL\": null,\n      \"TS\": null,\n      \"EcosystemName\": \"Amazon\",\n      \"EcosystemType\": \"River (basin)\",\n      \"Location\": \"South America\",\n      \"Salinity\": \"freshwater\",\n      \"RiverLength\": 6515,\n      \"Area\": null,\n      \"SizeRef\": 6232,\n      \"DrainageArea\": 7050000,\n      \"NorthernLat\": 1,\n      \"NrangeNS\": \"N\",\n      \"SouthernLat\": 16,\n      \"SrangeNS\": \"S\",\n      \"WesternLat\": 79,\n      \"WrangeEW\": \"W\",\n      \"EasternLat\": 49,\n      \"ErangeEW\": \"W\",\n      \"Climate\": \"tropical\",\n      \"AverageDepth\": null,\n      \"MaxDepth\": null,\n      \"DepthRef\": null,\n      \"TempSurface\": null,\n      \"TempSurfaceMap\": null,\n      \"TempDepth\": null,\n      \"Description\": null,\n      \"EcosystemURL1\": null,\n      \"EcosystemURL2\": null,\n      \"EcosystemURL3\": null,\n      \"DateEntered\": \"1993-11-24T00:00:00.000Z\",\n      \"DateModified\": \"2016-01-11T00:00:00.000Z\",\n      \"DateChecked\": \"2012-06-06T00:00:00.000Z\"\n    }\n  ],\n  \"error\": null\n}","language":"json","status":200}]},"settings":"","params":[{"name":"Accept","type":"string","default":"application/vnd.ropensci.v8+json","desc":"Version accept header","required":false,"in":"header","ref":"","_id":"5a1e4de01f1235001296604d"},{"name":"limit","type":"int","default":"10","desc":"number of records to return","required":false,"in":"query","ref":"","_id":"5a1e4e24721b9a0026bbf5f3"},{"name":"offset","type":"int","default":"0","desc":"record number to start at","required":false,"in":"query","ref":"","_id":"5a1e4ea51f12350012966050"},{"name":"fields","type":"string","default":"","desc":"Comma-separated string of fields to return","required":false,"in":"query","ref":"","_id":"5a1e530909ac8d003ef62a77"}]},"next":{"description":"","pages":[]},"title":"ecosystem","type":"endpoint","slug":"ecosystem","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additional Query Parameters\",\n  \"body\": \"In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body.\"\n}\n[/block]","updates":[],"order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e31b344969800124f4dc7","project":"5508a8940f146f3500b031c9","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"_id":"5508a8950f146f3500b031cc","__v":4,"createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","project":"5508a8940f146f3500b031c9"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Routes","slug":"heartbeat","order":1,"from_sync":false,"reference":false,"_id":"5a0e2fdcc96bc7001288e17d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","createdAt":"2017-11-17T00:39:56.122Z","__v":0},"user":"5508a87b99a1832100bf9569","createdAt":"2017-11-17T00:47:47.833Z","githubsync":"","__v":10,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

limit:
integer10
number of records to return
offset:
integer0
record number to start at
fields:
string
Comma-separated string of fields to return

Headers

Accept:
stringapplication/vnd.ropensci.v8+json
Version accept header

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Additional Query Parameters", "body": "In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}