Introduction

Function of the admin console

1. Blacklisting of terms - The console allows a blacklist of terms to be created and managed. Blacklisted terms are those that have been submitted to the GBIF network as scientific names or components of scientific names but are not. Blacklisted terms in the list are then used when processing the GBIF index.
2. Lexical group management - The console allows lexical groups of names to be manually curated (split or lumped). Lexical groups are algorithmically generated and are not 100% accurate. The console provides the means to manually mediate.

please add more

Webservices

Other existing webservices by CLB can be found at ecat-dev.gbif.org/api/clb.php

The following webservices have been created based on fake responses returned by this PHP script for the mockup console.

They have been modified to better fit the existing services in terms of response type consistency and compliance with Darwin Core.

Open Access

• Paging, if supported, is done via page and pagesize parameters
• callback parameter for cross domain calls are supported for all services

listBlacklist

/ws/name?status=blacklist

[{
  "id": 100059,
  "scientificName": "Clade",
  "status": "blacklisted"
},{
  "id": 100032,
  "scientificName": "Class",
  "status": "blacklisted"
},{
  "id": 100023,
  "scientificName": "Deus",
  "status": "blacklisted"
}]

searchLexicalGroups

/ws/name?q=Molothrus&lexical=true&review=true

return a list of matching names grouped by their lexical groups with all names for each of the group. If review=true (defaults to false), only names flagged for review will be searched. An empty querystring is permitted.

[{
  "id": 101147404,
  "kingdoms": ["Animalia"],
  "numNames": 1,
  "names": [ {
    "id": 513671,
    "scientificName": "Molothrus aeneus milleri",
    "canonicalNameId": 513671,
    "status": null
   }]
},{
  "id": 4388626,
  "kingdoms": ["Animalia"],
  "numNames": 2,
  "names": [ {
      "id": 139862,
      "scientificName": "Molothrus aeneus",
      "canonicalNameId": 139862,
      "status": null
    }, {
      "id": 4388626,
      "scientificName": "Molothrus aeneus Milleri",
      "canonicalNameId": 139862,
      "status": "valid"
    }]
}]

showName

/ws/name?id=4388626

return the details of a name string, i.e. mainly the parsed name atoms:

{
      "id": 4388626,
      "scientificName": "Molothrus aeneus Milleri",
      "canonicalNameId": 139862,
      "status": "valid",
      "hybrid": false,
      "parsingWrong": false,
      "genusOrAbove": "Molothrus",
      "infraGeneric": "",
      "specificEpithet": "aeneus",
      "rank": "",
      "infraspecificEpithet": "",
      "authorship": "Milleri",
      "year": "",
      "bracketAuthorship": "",
      "bracketYear": ""
    }

showUsages

/ws/usage?nid=NAMEID&type=untio

return a list of all usages for a given name including its dwc classification. The type parameter is optional and allows to limit the results to certain checklist types. Mostly useful to omit occurrence derived checklists as for certain higher names there are thousands of them. See CLB API for details.

[{
  "taxonID": 105410492,
  "datasetID": 1006,
  "higherTaxonID": 106881898,
  "scientificName": "Angadenia cognata (Stadelm.) Miers",
  "rank": "spec",
  "isSynonym": false,
  "numChildren": 0,
  "numDescendants": 0,
  "kingdom": "Plantae",
  "phylum": "",
  "class": "",
  "order": "",
  "family": "Apocynaceae",
  "subfamily": "",
  "genus": "",
  "subgenus": "",
  "species": "Angadenia cognata (Stadelm.) Miers",
  "higherClassification": "Plantae - Apocynaceae - Angadenia cognata (Stadelm.) Miers",
  "datasetTitle": "International Plant Names Index",
  "datasetType": "nomenclator"
},
{...}
]

Restricted Access

HTTPBasic authentication is used for restricting access

updateName

/ws/console?task=updateName&id=NAMEID&names=SCINAME_A|SCINAME_B|SCINAME_C|...&status=null/blacklisted/reviewed/valid&parsingWrong=false/true

Update some properties of a single or multiple names. Multiple names can be given as a pipe delimited list of case insensitive scientific names. A single name via the nid parameter. Both can be combined if desired.

The following properties are applied to all given names if given in the request:

• status: null/blacklisted/reviewed/valid
• parsingWrong: false/true

 {"success":true/false}

updateUsage

/ws/console?task=updateUsage&id=USAGE_ID&rating=0...5

Update some properties of a single name usage. The following properties are applied to the given usage if given:

• rating=0...5

 {"success":true/false}

mergeLexicalGroups

/ws/console?task=mergeLexicalGroups&id=LEXGROUPID1| LEXGROUPID2| LEXGROUPID3|...

Merges the given lexical groups into one group. The server decides which ID is reused or generated for the new merged group and return it.

 {"success":true,
  "mergedGroupID: 432
 } 

addName

/ws/console?task=addName&id=LEXGROUPID&nid=NAMEID

Adds the given name id to an existing lexical group

 {"success":true } 

removeName

/ws/console?task=addName&id=LEXGROUPID&nid=NAMEID

Removes the given name id from an existing lexical group

 {"success":true } 

moveName

/ws/console?task=moveName& nid=NAMEID&from=LEXGROUPID&to=LEXICALID

Moves the given name id from an existing lexical group to another existing group.

 {"success":true } 

Installation

A demo console is currently installed at http://ecat-dev.gbif.org/console/ accessing webservices at http://ecat-dev.gbif.org/ws/console/