- Resources
- Products
- Web services
- Vocab
- Version1.1 methods
Vocabulary Server Version 1.1 methods
Select from the following for more information on each method
- getList — retrieves a specific term and/or all terms on a given list.
- getMap — retrieves all terms from one or more lists, including their mappings to either one or more specified vocabularies or all vocabularies in the server.
- getRelatedRecordByCriteria — retrieves subject terms matching the given criteria and object terms matching the given predicate.
- getRelatedRecordByTerm — retrieves the subject term(s) referred to by the subjectTerm parameter and the object terms matching the given predicate.
- searchVocab — retrieves records containing a specified string (may include a wildcard) in the term, abbreviated term or definition.
- verifyTerm — verifies that a term, an abbreviated term or a term definition exists in a given list.
- whatLists — retrieves information (URL, name, abbreviation, definition, version number and version date) on all visible lists or all visible lists in a particular category.
- whatListsCat — retrieves the terms which describe the vocabulary server subject categories.
1. getList
Retrieves a specific term and/or all terms on a given list.
Parameters
| Name | Cardinality | Type | Description |
|---|---|---|---|
| recordKey | mandatory (>=1) | xsd:string | URI identifying a term or list of terms to retrieve information on. If a list is specified then all member terms will be returned. |
| earliestRecord | optional (1) | xsd:dateTime | If specified, no terms before this date will be returned. ISO date/time syntax is used, e.g. '2003-08-14T23:00:00.000Z'. |
Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX call
| |||
| Name | Cardinality | Type | Description |
| subjectList | mandatory (>=1) | xsd:string | URI of the subject list. |
| predicate | mandatory (1) | xsd:int | Specification of desired predicate. Please see predicate bit mask for more information. |
| objectList | optional (>=0) | xsd:string | If specified, only terms which are members of the specified lists will be returned. |
| inference | mandatory (1) | xsd:string | Specifies whether to include inferred relationships. Allowed values are
Please also see the caveats for the V1.1 Vocabulary Server release. |
Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis returns a document containing each term in the SeaDataNet Agreed Parameter Group vocabulary (P031) and its corresponding narrower terms in the BODC Parameter Discovery Vocabulary. 3. getRelatedRecordByCriteriaRetrieves subject terms matching the given criteria and any object terms matching the given predicate. Notes:
Parameters | |||
| Name | Cardinality | Type | Description |
| subjectList | optional (>=0) | xsd:string | If specified, only subject terms on the given list will be included in the results. |
| subjectField | optional (>=0) | xsd:string | If specified, selects the field used to locate the subjectText in. Available options are
|
| subjectText | mandatory (1) | xsd:string | Text to select matching subject terms by. |
| caseSensitivity | optional (1) | xsd:boolean | Perform a case sensitive comparison between subjectText and the selected field. Default=true |
| partialMatch | optional (1) | xsd:boolean | Perform a partial match between subjectText and the selected field. Equivalent to prepending and appending "*" to subjectText. Default=false |
| predicate | mandatory (1) | xsd:int | Specification of desired predicate. Please see predicate bit mask for more information. |
| objectList | optional (>=0) | xsd:string | If specified, only terms which are members of the specified lists will be returned. |
| inferences | mandatory (1) | xsd:string | Specifies whether to include inferred relationships. Allowed values are
Please also see the caveats for the V1.1 Vocabulary Server release. |
Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis is an example using the thesaurus. The string 'air temperature' hits one record in the thesaurus that is related to the narrower terms 'wet bulb temperature', 'dry bulb temperature' and 'dewpoint temperature' and the broader term 'meteorology'. 4. getRelatedRecordByTermRetrieves the subject term referenced by the passed in URI and all object terms matching the predicate. Parameters | |||
| Name | Cardinality | Type | Description |
| subjectTerm | mandatory (1) | xsd:string | URI of term to be used as the subject. |
| predicate | mandatory (1) | xsd:int | Specification of desired predicate. Please see predicate bit mask for more information. |
| objectList | optional (>=0) | xsd:string | If specified, only terms which are members of the specified lists will be returned. |
| inferences | mandatory (1) | xsd:string | Specifies whether to include inferred relationships. Allowed values are
Please also see the caveats for the V1.1 Vocabulary Server release. |
Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis returns a single term from the BODC Parameter Discovery Vocabulary (Temperature of the water column), together with every record mapped to it in the Vocabulary Server by any kind of relationship. 5. searchVocabRetrieves records containing a specified string (may include wildcards) in the term, abbreviated term or definition. Parameters | |||
| Name | Cardinality | Type | Description |
| listKey | optional (1) | xsd:string | If specified, only the given list will be searched. |
| searchTerm | mandatory (1) | xsd:string | Text to search the field identified by termType for. The character "*" is interpreted as zero or more instances of any character. |
| termType | optional (1) | xsd:string | If specified, selects the field used to locate searchTerm in. Available options are
|
Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis returns all records from the specified vocabulary containing the string 'emperature' in the full term name, such as 'Temperature of the water column' and 'Air temperature'. 6. verifyTermVerifies that a term, abbreviated term or term definition exists in a given list. Parameters | |||
| Name | Cardinality | Type | Description |
| listKey | mandatory (1) | xsd:string | URI of the list containing the term to be verified. |
| entryTerm | mandatory (1) | xsd:string | The text to verify against the list members. |
| termType | optional (1) | xsd:string | Selects the field used to locate entryTerm in. Available options are
|
Output | |||
| Name | Cardinality | Type | Description |
| verifiedTerm | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis returns both a codeTableRecord element and an error element indicating that the entry term supplied (WC_Temp) is a valid abbreviation in the specified list (P021). Invalid terms just return the error element. 7. whatListsRetrieves information (URL, name, abbreviation, definition, version number and version date) on all visible lists or all visible lists in a particular category (obtained from whatListsCat). Parameters | |||
| Name | Cardinality | Type | Description |
| categoryKey | optional (1) | xsd:string | If specified, only lists belonging to the subject category identified by this term URI will be returned. The available subject categories and their term URIs may be obtained using a call to the whatListsCat method. |
Output | |||
| Name | Cardinality | Type | Description |
| codeTableType | optional (>=0) | types:codeTableTypeType | Matching terms (if any) will be returned as instances of codeTableTypeType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableTypeType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX callThis returns a codeTableTypeType instance for each list in the subject category known by the URI http://vocab.ndg.nerc.ac.uk/term/C980/current/CL12 (SeaDataNet Controlled Vocabularies). 8. whatListsCatRetrieves the terms which describe the Vocabulary Server subject categories. ParametersNone Output | |||
| Name | Cardinality | Type | Description |
| codeTableRecord | optional (>=0) | types:codeTableRecordType | Matching terms (if any) will be returned as instances of codeTableRecordType. Please see XML data types for more information. |
| error | mandatory (1) | xsd:boolean | Indicates whether an error has ocurred during processing. If so, the value of this element will be true and all instances of codeTableRecordType returned with the response MUST be considered invalid and discarded. |
Example HTTP-POX call
http://vocab.ndg.nerc.ac.uk/axis2/services/vocab/whatListsCat
