{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/faoareas","auth":"required","method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoareas?limit=1 | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 60522,\n \"returned\": 1,\n \"data\": [\n {\n \"autoctr\": 483,\n \"AreaCode\": 1,\n \"SpecCode\": 2,\n \"StockCode\": 1,\n \"Status\": \"endemic\",\n \"Entered\": 2,\n \"DateEntered\": \"1990-10-19T00:00:00.000Z\",\n \"Modified\": 675,\n \"DateModified\": \"2011-02-11T17:16:45.000Z\",\n \"Expert\": null,\n \"DateChecked\": null,\n \"TS\": null\n }\n ],\n \"error\": null\n}","name":""}]},"settings":"","params":[{"name":"limit","type":"int","default":"10","desc":"number of records to return","required":false,"in":"query","ref":"","_id":"5a1e4e2e64c7360012a285d3"},{"name":"offset","type":"int","default":"0","desc":"record number to start at","required":false,"in":"query","ref":"","_id":"5a1e4eb7721b9a0026bbf608"},{"name":"fields","type":"string","default":"","desc":"Comma-separated string of fields to return","required":false,"in":"query","ref":"","_id":"5a1e5312fbd088001c87d3fa"},{"name":"Accept","type":"string","default":"application/vnd.ropensci.v8+json","desc":"Version accept header","required":false,"in":"header","ref":"","_id":"5a1e544b1f12350012966069"}]},"next":{"description":"","pages":[]},"title":"faoareas","type":"endpoint","slug":"faoareas","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":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e31f6c01242001cac3c18","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:48:54.559Z","githubsync":"","__v":10,"parentDoc":null}
getfaoareas
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