ICES Vocabularies
Code lists (vocabularies) used in ICES data: code types, the codes in each type, and the relations between them.
Base url: https://vocab.ices.dk/services/api · Documentation · Website
Checked 21 November 2026, 13:18 UTC. Responses are compared with the baseline recorded on 2026-10-20.
Used by
Directly: icesVocab
Through a dependency: buseful, fisheriesXplorer, icesDatsuQC, icesTAF, icesTAFextra, icesUtils, icesVMS
Notes
| Topic | Observation | Affects |
|---|---|---|
| Unknown code types and codes | An unknown code type or code returns HTTP 200 with an empty result, not 404: Code/NoSuchType gives [], and CodeDetail/Gear/NOSUCH gives a record with id 0, an all-zero guid and empty relations. |
getCodeList() and getCodeDetail() return empty results rather than an error for a misspelt code type or code. |
| Size of code details | CodeDetail includes every related code, so it can be large: CodeDetail/ISO_3166/DK is about 1 MB. |
getCodeDetail() can be slow for widely used codes. |
| Case of field names | Field names are camelCase throughout (id, guid, key, longDescription, firstGUID). |
icesVocab converts them with CamelCase(); the change check reports any change of case. |
| Documentation | The documentation lists two operations not used by icesVocab: Code?codeID= and CodeTypeRelation. |
Nothing at present. |
Endpoints checked
| Endpoint | Status | HTTP | Time (s) | Size (kB) | Records | Fields |
|---|---|---|---|---|---|---|
| Code | No changes | 200 | 1.06 | 26.1 | 100 | 11 |
| Code, by code | No changes | 200 | 0.12 | 0.2 | 1 | 11 |
| Code, modified since | No changes | 200 | 0.13 | 5.1 | 16 | 11 |
| CodeType | No changes | 200 | 0.22 | 116.1 | 583 | 8 |
| CodeType, by code type | No changes | 200 | 0.11 | 0.2 | 1 | 8 |
| CodeDetail | No changes | 200 | 0.14 | 5.3 | 1 | 53 |
| CodeType Relation | No changes | 200 | 0.37 | 505.0 | 1950 | 11 |
Changes since the baseline
No changes: every endpoint returns the same structure as the baseline.
Documented operations
The documentation (ICES VOCABULARIES API v1) lists 6 operations, of which 4 are checked here. No changes to the operations or their parameters since the baseline.
| Operation | Parameters | Checked |
|---|---|---|
GET /Code/{codeType} |
codeType (path, string, required) code (query, string) modified (query, string) |
Code, Code, by code, Code, modified since |
GET /Code |
codeID (query, integer) | |
GET /CodeDetail/{codeType}/{code} |
codeType (path, string, required) code (path, string, required) |
CodeDetail |
GET /CodeType |
codeType (query, string) codeTypeID (query, integer) modified (query, string) |
CodeType, CodeType, by code type |
GET /CodeType/Relation/{firstCodeType}/{secondCodeType} |
firstCodeType (path, string, required) secondCodeType (path, string, required) modified (query, string) |
CodeType Relation |
GET /CodeTypeRelation |
modified (query, string) |
R functions
The packages are designed with one R function for each endpoint, and further functions that combine endpoints into a dataset. Functions are found by reading the code of icesVocab. 4 of the 6 operations that read data have an R function; a function name is suggested for the others.
Operations and R functions
| Operation | R function | Also used in |
|---|---|---|
GET /Code/{codeType} |
getCodeList() |
findAphia(), findCode(), linkCodes() |
GET /Code |
missing: suggest getCode() |
|
GET /CodeDetail/{codeType}/{code} |
getCodeDetail() |
linkCodes() |
GET /CodeType |
getCodeTypeList() |
findCode(), findCodeType() |
GET /CodeType/Relation/{firstCodeType}/{secondCodeType} |
getCodeTypeRelation() |
|
GET /CodeTypeRelation |
missing: suggest getCodeTypeRelationList() |
Combined functions
| Function | Builds on | Operations |
|---|---|---|
findAphia() |
getCodeList() |
/Code/{codeType} |
findCode() |
findCodeType(), getCodeList() |
/Code/{codeType}, /CodeType |
findCodeType() |
getCodeTypeList() |
/CodeType |
linkCodes() |
getCodeDetail(), getCodeList() |
/Code/{codeType}, /CodeDetail/{codeType}/{code} |
Endpoint details
Code
https://vocab.ices.dk/services/api/Code/Gear
Called by: getCodeList(), findAphia(), findCode(), linkCodes()
Operation: GET /Code/{codeType}
HTTP 200 · application/json · 1.06 s · 100 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].codeTypeGUID |
string |
[].codeTypeID |
number |
[].deprecated |
boolean |
[].description |
string |
[].guid |
string |
[].id |
number |
[].key |
string |
[].longDescription |
string | string (empty) |
[].modified |
string (date-time) |
Code, by code
https://vocab.ices.dk/services/api/Code/SpecWoRMS?code=126436
Called by: getCodeList(), findAphia(), findCode(), linkCodes()
Operation: GET /Code/{codeType}
HTTP 200 · application/json · 0.12 s · 1 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].codeTypeGUID |
string |
[].codeTypeID |
number |
[].deprecated |
boolean |
[].description |
string |
[].guid |
string |
[].id |
number |
[].key |
string (number) |
[].longDescription |
string |
[].modified |
string (date-time) |
Code, modified since
https://vocab.ices.dk/services/api/Code/Gear?modified=2025-01-01
Called by: getCodeList(), findAphia(), findCode(), linkCodes()
Operation: GET /Code/{codeType}
HTTP 200 · application/json · 0.13 s · 16 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].codeTypeGUID |
string |
[].codeTypeID |
number |
[].deprecated |
boolean |
[].description |
string |
[].guid |
string |
[].id |
number |
[].key |
string |
[].longDescription |
string | string (empty) |
[].modified |
string (date-time) |
CodeType
https://vocab.ices.dk/services/api/CodeType
Called by: getCodeTypeList(), findCode(), findCodeType()
Operation: GET /CodeType
HTTP 200 · application/json · 0.22 s · 583 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].description |
string |
[].guid |
string |
[].id |
number |
[].key |
string |
[].longDescription |
string | string (empty) |
[].modified |
string (date-time) |
CodeType, by code type
https://vocab.ices.dk/services/api/CodeType?codeType=Gear
Called by: getCodeTypeList(), findCode(), findCodeType()
Operation: GET /CodeType
HTTP 200 · application/json · 0.11 s · 1 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].description |
string |
[].guid |
string |
[].id |
number |
[].key |
string |
[].longDescription |
string (empty) |
[].modified |
string (date-time) |
CodeDetail
https://vocab.ices.dk/services/api/CodeDetail/SpecWoRMS/101170
Called by: getCodeDetail(), linkCodes()
Operation: GET /CodeDetail/{codeType}/{code}
HTTP 200 · application/json · 0.14 s · 1 records
| Field | Type |
|---|---|
(root) |
object |
attribute |
array |
childRelation |
array |
childRelation[] |
object |
childRelation[].code |
object |
childRelation[].code.codeTypeGUID |
string |
childRelation[].code.codeTypeID |
number |
childRelation[].code.deprecated |
boolean |
childRelation[].code.description |
string |
childRelation[].code.guid |
string |
childRelation[].code.id |
number |
childRelation[].code.key |
string |
childRelation[].code.longDescription |
string (empty) |
childRelation[].code.modified |
string (date-time) |
childRelation[].codeType |
object |
childRelation[].codeType.description |
string |
childRelation[].codeType.guid |
string |
childRelation[].codeType.id |
number |
childRelation[].codeType.key |
string |
childRelation[].codeType.longDescription |
string | string (empty) |
childRelation[].codeType.modified |
string (date-time) |
childRelation[].modified |
string (date-time) |
codeTypeGUID |
string |
codeTypeID |
number |
deprecated |
boolean |
description |
string |
externalRelation |
array |
guid |
string |
id |
number |
key |
string (number) |
longDescription |
string (empty) |
modified |
string (date-time) |
parentRelation |
array |
parentRelation[] |
object |
parentRelation[].code |
object |
parentRelation[].code.codeTypeGUID |
string |
parentRelation[].code.codeTypeID |
number |
parentRelation[].code.deprecated |
boolean |
parentRelation[].code.description |
string |
parentRelation[].code.guid |
string |
parentRelation[].code.id |
number |
parentRelation[].code.key |
string |
parentRelation[].code.longDescription |
string (empty) |
parentRelation[].code.modified |
string (date-time) |
parentRelation[].codeType |
object |
parentRelation[].codeType.description |
string |
parentRelation[].codeType.guid |
string |
parentRelation[].codeType.id |
number |
parentRelation[].codeType.key |
string |
parentRelation[].codeType.longDescription |
string (empty) |
parentRelation[].codeType.modified |
string (date-time) |
parentRelation[].modified |
string (date-time) |
synonym |
array |
CodeType Relation
https://vocab.ices.dk/services/api/CodeType/Relation/Pargroup/PARAM
Called by: getCodeTypeRelation()
Operation: GET /CodeType/Relation/{firstCodeType}/{secondCodeType}
HTTP 200 · application/json · 0.37 s · 1950 records
| Field | Type |
|---|---|
(root) |
array |
[] |
object |
[].firstCodeType |
string |
[].firstGUID |
string |
[].firstID |
number |
[].firstKey |
string |
[].modified |
string (date-time) |
[].secondCodeType |
string |
[].secondGUID |
string |
[].secondID |
number |
[].secondKey |
string |