{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/faoareas/:id","auth":"required","method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoareas/8 |  jq ."}]},"results":{"codes":[{"status":200,"language":"json","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    ...","name":""}]},"settings":"","params":[{"name":"id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"5a0e322e3de7c500262d53f7"},{"name":"limit","type":"int","default":"10","desc":"number of records to return","required":false,"in":"query","ref":"","_id":"5a1e4e3e721b9a0026bbf604"},{"name":"offset","type":"int","default":"0","desc":"record number to start at","required":false,"in":"query","ref":"","_id":"5a1e4ed21f12350012966051"},{"name":"fields","type":"string","default":"","desc":"Comma-separated string of fields to return","required":false,"in":"query","ref":"","_id":"5a1e531f721b9a0026bbf6bb"},{"name":"Accept","type":"string","default":"application/vnd.ropensci.v8+json","desc":"Version accept header","required":false,"in":"header","ref":"","_id":"5a1e54541f1235001296606a"}]},"next":{"description":"","pages":[]},"title":"faoareas by id","type":"endpoint","slug":"faoareas-by-id","excerpt":"","body":"","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e3218c01242001cac3c19","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:49:28.461Z","githubsync":"","__v":9,"parentDoc":null}

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