TaxaResource Resource

GET /api/v1/{portalId}/taxa

Request Parameters
name type description default constraints multivalued
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.     no
portalId path The portal   required, min: 1 no
externalKeys query Filters by the given external keys.     yes
languages query languages of the taxa LAT "CYM" or "DEU" or "ENG" or "GLA" or "GLE" or "LAT" yes
limit query 10 int no
nameContains query Filter by the name of the taxa

The search term is split up into parts and each part is checked to be the starting part of the corresponding part of the taxa.

This search is case insensitive.

Taxon nameContains matches
Abies alba "ABIES" true
Abies alba " ABIES" false
Abies alba "AB AL" true
    no
occurrencesChangedSince query only return taxa for which occurrences have changed since a given date     no
offset query 0 min: 0 no
onlyTaxaAvailableForInput query false boolean no
onlyUsedTaxa query If set to true, only taxa wich are used for occurrences are returned. false boolean no
taxaGroup query     no
withSynonyms query If set to true, also synonyms of the taxa are returned. false boolean no
Response Body
media type data type description
application/json TaxonBaseSliceResponse (JSON)
application/xml taxonBaseSliceResponse (XML)

Example

Request
GET /v1/{portalId}/taxa
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "taxon" : [ {
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "DELETE", "CREATE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "UNBEKANNT",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "DELETE", "UPDATE" ]
  }, {
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "UPDATE", "CREATE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "ANGESALBT_KULTIVIERT",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "UPDATE", "CREATE" ]
  } ],
  "size" : 12345,
  "numberOfElements" : 12345,
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/count

Request Parameters
name type description default constraints multivalued
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.     no
portalId path The portal   required, min: 1 no
externalKeys query Filters by the given external keys.     yes
languages query languages of the taxa LAT "CYM" or "DEU" or "ENG" or "GLA" or "GLE" or "LAT" yes
nameContains query Filter by the name of the taxa

The search term is split up into parts and each part is checked to be the starting part of the corresponding part of the taxa.

This search is case insensitive.

Taxon nameContains matches
Abies alba "ABIES" true
Abies alba " ABIES" false
Abies alba "AB AL" true
    no
occurrencesChangedSince query only return taxa for which occurrences have changed since a given date     no
onlyTaxaAvailableForInput query false boolean no
onlyUsedTaxa query If set to true, only taxa wich are used for occurrences are returned. false boolean no
taxaGroup query     no
withSynonyms query If set to true, also synonyms of the taxa are returned. false boolean no
Response Body
media type data type description
application/json CountResponse (JSON)
application/xml countResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/count
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "amount" : 12345,
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/meta

Request Parameters
name type description constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.  
portalId path required, min: 1
Response Body
media type data type description
application/json TaxonFieldConfigResponse (JSON)
application/xml taxonFieldConfigResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/meta
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "fieldConfigs" : [ {
    "field" : "LANGUAGE",
    "mandantory" : true,
    "property" : "...",
    "translationKey" : "...",
    "values" : [ {
      "value" : "...",
      "translationKey" : "..."
    }, {
      "value" : "...",
      "translationKey" : "..."
    } ]
  }, {
    "field" : "AUTHORITY",
    "mandantory" : true,
    "property" : "...",
    "translationKey" : "...",
    "values" : [ {
      "value" : "...",
      "translationKey" : "..."
    }, {
      "value" : "...",
      "translationKey" : "..."
    } ]
  } ]
}

GET /api/v1/{portalId}/taxa/{id}

Request Parameters
name type description constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.  
id path required
portalId path required, min: 1
Response Body
media type data type description
application/json TaxonResponse (JSON)
application/xml taxonResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/{id}
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "taxon" : {
    "redListStatus" : "ONE",
    "documents" : [ {
      "type" : "MAP_TAXON_FLORA_MV_STYLE",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "MAP_TAXON_FLORA_MV_STYLE",
      "link" : { },
      "caption" : "..."
    } ],
    "language" : "LAT",
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "UPDATE", "CREATE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "ANGESIEDELT",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "DELETE", "DELETE" ]
  },
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/meta/{surveyId}

Returns the survey specific field configuration

Request Parameters
name type description constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.  
portalId path required, min: 1
surveyId path required, min: 1
Response Body
media type data type description
application/json TaxonFieldConfigResponse (JSON)
application/xml taxonFieldConfigResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/meta/{surveyId}
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "fieldConfigs" : [ {
    "field" : "ID",
    "mandantory" : true,
    "property" : "...",
    "translationKey" : "...",
    "values" : [ {
      "value" : "...",
      "translationKey" : "..."
    }, {
      "value" : "...",
      "translationKey" : "..."
    } ]
  }, {
    "field" : "RED_LIST_STATUS",
    "mandantory" : true,
    "property" : "...",
    "translationKey" : "...",
    "values" : [ {
      "value" : "...",
      "translationKey" : "..."
    }, {
      "value" : "...",
      "translationKey" : "..."
    } ]
  } ]
}

GET /api/v1/{portalId}/taxa/{id}/coveredMTB

Request Parameters
name type description default constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.    
id path   required
portalId path   required, min: 1
inclusiveChildTaxa query true boolean
Response Body
media type data type description
application/json MTBResponse (JSON)
application/xml MTBResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/{id}/coveredMTB
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "mtb" : [ {
    "mtb" : "..."
  }, {
    "mtb" : "..."
  } ],
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/{id}/coveredMTBFiltered

Request Parameters
name type description default constraints multivalued
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.     no
id path   required no
portalId path   required, min: 1 no
from query     no
inclusiveChildTaxa query true boolean no
sampleTag query     no
surveyId query   int no
to query     no
validationStatus query   "IMPROBALE" or "INVALID" or "PROBABLE" or "UNCHECKED" or "UNKNOWN" or "VALID" yes
Response Body
media type data type description
application/json MTBResponse (JSON)
application/xml MTBResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/{id}/coveredMTBFiltered
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "mtb" : [ {
    "mtb" : "..."
  }, {
    "mtb" : "..."
  } ],
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/{id}/evict

Request Parameters
name type description default constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.    
id path   required
portalId path   required, min: 1
inclusiveChildTaxa query true boolean
Response Body
media type data type description
application/json TaxonResponse (JSON)
application/xml taxonResponse (XML)

Example

Request
GET /v1/{portalId}/taxa/{id}/evict
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "taxon" : {
    "redListStatus" : "ONE",
    "documents" : [ {
      "type" : "MAP_TAXON_VEGETWEB_STYLE_THUMB",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "MAP_TAXON_VEGETWEB_STYLE_THUMB",
      "link" : { },
      "caption" : "..."
    } ],
    "language" : "DEU",
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "UPDATE", "CREATE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "EINGEBUERGERT",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "UPDATE", "CREATE" ]
  },
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}

GET /api/v1/{portalId}/taxa/{id}/synonyms

Request Parameters
name type description constraints
werbeo-request-source-id header A request id set by the client. Used to trace requests in log files.  
id path required
portalId path required, min: 1
Response Body
media type data type description
application/json TaxonSliceResponse (JSON)

Example

Request
GET /v1/{portalId}/taxa/{id}/synonyms
Content-Type: */*
Accept: application/json
werbeo-request-source-id: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "taxon" : [ {
    "redListStatus" : "SAFE",
    "documents" : [ {
      "type" : "MAP_TAXON_VEGETWEB_STYLE",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "IMAGE_THUMB",
      "link" : { },
      "caption" : "..."
    } ],
    "language" : "ENG",
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "DELETE", "UPDATE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "SYNANTHROP",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "DELETE", "DELETE" ]
  }, {
    "redListStatus" : "D",
    "documents" : [ {
      "type" : "MAP_TAXON_VEGETWEB_STYLE",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "MAP_TAXON_VEGETWEB_STYLE_THUMB",
      "link" : { },
      "caption" : "..."
    } ],
    "language" : "ENG",
    "name" : "...",
    "authority" : "...",
    "group" : "...",
    "taxaList" : {
      "name" : "...",
      "description" : "...",
      "taxaGroups" : [ "...", "..." ],
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "READ", "DELETE" ]
    },
    "externalKey" : "...",
    "defaultSettlementStatusFukarek" : "EINGEBUERGERT",
    "preferred" : true,
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "CREATE", "UPDATE" ]
  } ],
  "size" : 12345,
  "numberOfElements" : 12345,
  "metaData" : {
    "creationTime" : 12345,
    "sessionId" : "..."
  }
}