Taxa Reference Service (trs_rest) 0.2.5

Introduction

This is the NIWA API for our taxa reference system

Disclaimer

This is beta software. You are free to use it but we accept no responsibility of any kind.

REST

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

There is also a WADL document describing the REST API.

Data

All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema , which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON .

This document will describe the data using terms based on XML Schema . Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type .

Data Schemas

id namespace schema file
ns2 http://purl.org/dc/terms/ ns2.xsd
ns1 http://rs.tdwg.org/dwc/dwcore/ ns1.xsd
ns0 http://www.niwa.co.nz/trs/ ns0.xsd
ns3 http://www.xml.org/xml/ ns3.xsd

XML Data Elements

XML Data Types