CAAB TNS Test Interface v.1.0
Based on model at http://dev.terrapages.com/noocat/Classifications.html (v.3_3_4)
Service Parameters
service
(not supplied)
Classifications
Scheme
"Classifications" is used to request information about the content (nodes), as opposed to information about the scheme (root node, no ID). If not supplied, defaults to "Classifications".
Operational, if no value supplied assume "Classifications"
request
(not supplied)
GetRecords
GetInfo
ShowRequest
Export
"GetRecords" is used to request content information from the CAAB TNS. "Export" is used to create dumps of the classification scheme in a format specified by the Marine Catalogue. If not supplied, defaults to "GetRecords".
Not yet operational, all requests currently assume "GetRecords" (only alternative supported: "Export", under development at present time).
Request Parameters
These parameters only apply to the base query
resultType
(not supplied)
RESULTS
HITS
VALIDATE
"RESULTS" gives full result including number of hits, "HITS" gives number of hits only. "VALIDATE" is not supported at this time. If not supplied, defaults to "RESULTS".
Operational for "RESULTS" and "HITS" only at present time
startPosition
If not supplied, defaults to "1".
Operational
maxRecords
If not supplied, defaults to "10".
Operational
Search Options
sortField
(not supplied)
/ClassificationNode/@path
/ClassificationNode/Name/LocalizedString/@value
Options supported are "/ClassificationNode/Name/LocalizedString/@value" (sort on item name[=value]), and "/ClassificationNode/@path" (sort on item path). Higher values of path are sorted according to position in OBIS hierarchy, mammals through viruses, rather than alphabetically; familes are sorted on family common name; genera on genus scientific name; species on species common name then scientific name. If no value supplied, assumes sort on item name. If not supplied, defaults to "/ClassificationNode/Name/LocalizedString/@value".
Operational
sortOrder
(not supplied)
ASC
DESC
If not supplied, defaults to Ascending ("ASC").
Operational
searchLogic
(not supplied)
And
Or
If not supplied, will default to "And".
Not currently implemented (ignored if supplied).
classNodeRecursion
Not currently implemented (ignored if supplied).
Search Parameters
nameSearch
Term being searched in "name" slot (exact matches only, does not include search in alternate names or fuzzy matching).
Options currently supported:
- match on full term e.g. "Andrews' beaked whale (Mesoplodon bowdoini)", "family Cetomimidae (whalefishes)" (no wildcard support) - setting of nametype is ignored
- match on common name portion alone, e.g. "Andrews' beaked whale", "whalefishes", if nametype = "Common name" (wildcards supported)
- match on scientific name portion alone, e.g. "Mesoplodon bowdoini", "Cetomimidae", if nametype = "Scientific name" (wildcards supported).
If supplied, takes precedence over pathSearch.
Operational
codeSearch
CAAB code only, e.g. "37441004". Supports wildcards "%" or "*" if entered manually (or if automatically added in the client app.). Will take precedence over a pathSearch, nameSearch or idsearch if supplied.
Operational
pathSearch
Term being searched for common name / scientific name searches (includes search in alternate names), according to setting of "nametype" field. Will do fuzzy match against scientific names if no exact match found. Common name searches are tolerant of mis-matches in spaces, hyphenation, and apostrophes. Not case sensitive. Supports wildcards "%" or "*" if entered manually (or if automatically added in the client app.). All searches currently add leading and trailing wildcards anyway, if not supplied (though this can be changed later if needed).
Operational
Name type:
(not supplied)
Common name
Scientific name
Operates in conjunction with "nameSearch" and"pathSearch". If not supplied, defaults to "Common name".
Operational
idSearch
CAAB code plus namespace etc., e.g. "urn:caab:caab_tns:v1.0:37441004". Does not support wildcards. Will take precedence over a pathSearch or codeSearch if supplied. Also will accept a restricted set of GCMD parameters that map to CAAB identifiers, in NOO Catalogue prescribed format only, e.g. "urn:asdi:marine:gcmd-taxonomy:v2.0:GCMD-1-3-1-14" for mammals, etc. Will take precedence over a pathSearch or nameSearch (but not idsearch) if supplied
Operational
schemeSearch
(not supplied)
urn:caab:caab_tns:v1.0
Scheme to search. If left blank, search will proceed across all available schemes (currently only "urn:caab:caab_tns:v1.0" is available). If this parameter is used, values other than "urn:caab:caab_tns:v1.0" will not produce a result.
Operational
descriptionSearch
Not yet operational, no result if supplied
Species type:
Any
Commonly requested species
Commercially caught species
Recreational fishery species
Endangered species
Introduced / pest species
Operates in conjunction with nameSearch or pathSearch (only) as required, in tandem with "species group". If not supplied, defaults to "Any". Actual values for this parameter are currently null=Any, 1=Commonly requested species, 2=Commercially caught species, 3=Recreational fishery species, 4=Endangered species, and 5=Introduced / pest species.
Operational
Species group:
Any
Marine mammals
Marine birds
Marine reptiles
Marine fishes
Marine invertebrates
Marine plants
Marine phytoplankton
Operates in conjunction with nameSearch or pathSearch (only) as required, in tandem with "Species type". This is a partial list only, can be extended as needed. If not supplied, defaults to "Any". Sample actual values for this parameter are currently null=Any, 2000=Marine mammals, 2001=Marine birds, 2002=Marine reptiles, 2004=Marine fishes, 1002=Marine invertebrates, 1003=Marine plants, 2055=Marine phytoplankton.
Operational
Search Extensions
includeAlternates
(not supplied)
false
true
Searches for
nameSearch
value in the Slot
alternateNames
. If not supplied, will default to true.
Operational
includeParents
(not supplied)
false
true
was
includeBroader
. If not supplied, will default to false.
Operational
includeChildren
(not supplied)
false
true
was
includeNarrower
. If not supplied, will default to false.
Operational
includeStatistics
(not supplied)
false
true
Not currently implemented (ignored if supplied).
Extensions for testing purposes only
Debug
If checked, will add diagnostics to the response
Operational.