{"_id":"5a0e3218c01242001cac3c19","project":"5508a8940f146f3500b031c9","version":{"_id":"5508a8950f146f3500b031cc","__v":4,"project":"5508a8940f146f3500b031c9","createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5a0e2fdcc96bc7001288e17d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-11-17T00:39:56.122Z","from_sync":false,"order":1,"slug":"heartbeat","title":"Routes"},"user":"5508a87b99a1832100bf9569","githubsync":"","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:49:28.461Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl https://fishbase.ropensci.org/faoareas/8 |  jq .","language":"shell"}]},"results":{"codes":[{"name":"","code":"{\n  \"count\": 8,\n  \"returned\": 8,\n  \"data\": [\n    {\n      \"autoctr\": 52806,\n      \"AreaCode\": 8,\n      \"SpecCode\": 238,\n      \"StockCode\": 252,\n      \"Status\": \"native\",\n      \"Entered\": 1016,\n      \"DateEntered\": \"2003-07-22T00:00:00.000Z\",\n      \"Modified\": null,\n      \"DateModified\": \"2003-07-22T00:00:00.000Z\",\n      \"Expert\": null,\n      \"DateChecked\": null,\n      \"TS\": null\n    },\n    ...","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5a0e322e3de7c500262d53f7","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"5a1e4e3e721b9a0026bbf604","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4ed21f12350012966051","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e531f721b9a0026bbf6bb","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54541f1235001296606a","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v8+json","type":"string","name":"Accept"}],"url":"/faoareas/:id"},"isReference":false,"order":11,"body":"","excerpt":"","slug":"faoareas-by-id","type":"endpoint","title":"faoareas by id"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

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


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 }}