Portal de Datos del Sistema Nacional de Datos Biológicos 

Servicios de datos

El registro de Atlas of Living Australia contiene metadatos que describen:

  • Colecciones - colecciones de historia natural;
  • instituciones - instituciones y organizaciones que gestionan las colecciones;
  • ProveedoresDeDatos - proveedores de información sobre biodiversidad en forma electrónica, por ejemplo registros de ocurrencia, sitios web;
  • RecursosDeDatos - recursos específicos a disposición de los proveedores de datos;
  • RecursosDeDatosTemporales - Los recursos temporales mantienen registros cargados en el sandbox;
  • CentrosDeDatos - agregadores de datos sobre biodiversidad; y
  • contactos - para cualquiera de los anteriores recursos.

El acceso a estos metadatos es proporcionado por servicios web orientados a recursos se adhieren a RESTful principios. La respuesta de la capacidad de carga están generalmente formateadas como JSON Aunque algunos servicios ofrecen otros formatos a través de la negociación de contenido.

Los detalles de cómo se pueden utilizar estos servicios son proporcionados en el proyecto de wiki, y, en particular aquí.

Formulario de URIs

Todo los servicio de URIs se basan en la URI de esta página: https://collections.ala.org.au/ws
Las URI de los recursos mencionados son esta raíz más el nombre del tipo de recurso, por ejemplo: https://collections.ala.org.au/ws/institution
El URI para una instancia específica de un recurso es el mismo seguido por el UID de la instancia. Por ejemplo, el recurso que representa el Aust. Wine Research Institute (UID = in72) es: https://collections.ala.org.au/ws/institution/in72
La URI para obetener el recuento total de un recurso en particual es el nombre del recurso seguido por 'count'. Por ejemplo, el número de intituciones que se dan en: https://collections.ala.org.au/ws/institution/count
Cuenta los recursos agrupados por un atributo. Por ejemplo, el desglose de las instituciones por estado es dada por: https://collections.ala.org.au/ws/institution/count/state
Las fuentes que son atributos de un recurso, tales como la lista de contacto de una colección, son usados para anexar el tipo de recuros a la uri que representa el recurso principal, por ejemplo: https://collections.ala.org.au/ws/institution/in72/contacts

Métodos

Los servicios de datos se apoyan en los métodos GET, HEAD, POST, PUT, OPTIONS y DELETE.

GET devolverá la representación json del recurso especificado o la lista de todos los recursos del tipo de recurso especificado.

HEAD no devolverá ningún contenido pero le confirmará la existencia del recurso especificado.

POST se actualizará el recurso especificado en base a la información del cuerpo de la solicitud. Si no se especifica un recurso, la información en el cuerpo se usará para crear un nuevo recurso. El cuerpo debe ser una llamada json válida y usted debe especificar al menos estas propiedades:

  • usuario - el nombre de la aplicación que está solicitando la actualización; y
  • api_key - una clave válida para verificar que está autorizado para modificar el recurso.

Si un nuevo recurso está siendo creado usted debe especificar al menos:

  • nombre - el nombre del recurso

Otras propiedades son tratadas como las propiedades a ser actualizadas. Los nombres de propiedades son las mismas que las utilizadas en la representación GET.

PUT se comporta igual que el POST.

OPTIONS Devuelve una lista de los métodos permitidos.

DELETE eliminará el recurso especificado. El cuerpo json debe ser válido y se deben especificar estas propiedades:

  • usuario - el nombre de la aplicación que está solicitando la actualización; y
  • api_key - una clave válida para verificar que está autorizado para modificar el recurso.

Contactos

Los contactos existen como un recuros pro derecho propio. Y pueden ser accedidos de la forma estándar.

Listar todos los contactos: https://collections.ala.org.au/ws/contacts
Obtener detalles de un contacto específico https://collections.ala.org.au/ws/contacts/31
Buscar un contacto por su dirección de correo electrónico https://collections.ala.org.au/ws/contacts/email/dave.martin@csiro.au

Editar contactos sigue el mismo patrón que las principales entidades. PUT y POST se actualizará un contacto si se especifica un id en la url, ademas se añade un nuevo contacto. DELETE eliminará un contacto.

El cuerpo debe ser una llamada json válida y usted debe especificar al menos estas propiedades:

  • usuario - el nombre de la aplicación que está solicitando la actualización; y
  • api_key - una clave válida para verificar que está autorizado para modificar el recurso.

y también puede especificar

  • Nombre
  • Apellido
  • fax
  • teléfono
  • teléfono móvil
  • notas
  • público (verdadero o falso) - controla si el contacto se mostrará en una página web pública

Tenga en cuenta que los contactos no tiene UIDs. En su lugar usan los IDs asigandos en la BD.

El correo electrónico del usuario es efectivamente la clave principal para un contacto. Compruebe siempre si existe un contacto (mediante la búsqueda de su dirección de correo electrónico) antes de crear uno.

Relaciones entre contactos

Un contacto puede estar asociado con varios recursos. Un recurso puede tener muchos contactos. La relación entre un contacto y un recurso tiene sus propios metadatos tales como el rol que tiene el contacto en relación con el recurso, los derechos de edición de contacto, etc.

Este metadato es accecido por anexación contactos el URI de un recurso utilizando el formulario:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts
Por ejemplo: https://collections.ala.org.au/ws/collection/co13/contacts
Los metadatos para una conexión específica de contacto tiene el formulario:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/{id}
Por ejemplo: https://collections.ala.org.au/ws/collection/co13/contacts/20
Los contactos principales para todas las instancias de un tipo de recurso pueden ser accedidos usando el formulario:
GET https://collections.ala.org.au/ws/{resource type}/contacts
Por ejemplo: https://collections.ala.org.au/ws/collection/contacts
Los contactos pueden elegir ser notificados cuando se produzcan eventos importantes en un recurso. La lista de contactos para ser notificados de un recurso específico puede ser obtenida de un uri de la forma:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/notifiable
Por ejemplo: https://collections.ala.org.au/ws/collection/co13/contacts/notifiable
Puede recuperar todas las entidades que el contacto especificado está autorizado a editar. La uri tiene la forma:
GET https://collections.ala.org.au/ws/contacts/{contact id}/authorised
Por ejemplo: https://collections.ala.org.au/ws/contacts/132/authorised

Todos los servicios de contacto se pueden cargar como CSV, XML o JSON mediante negociación del contenido.
Más información.

Las relaciones del contacto pueden actualizarse siguiendo las normas habituales. El contacto ya debe existir.

POST agregará el contacto a un recurso si no existe o actualizará la relación usando los datos en el cuerpo de la solicitud json.

El cuerpo debe ser una llamada json válida y usted debe especificar al menos estas propiedades:

  • usuario - el nombre de la aplicación que está solicitando la actualización; y
  • api_key - una clave válida para verificar que está autorizado para modificar el recurso.

y también puede especificar

  • Rol - Rol que el contacto tiene para este recurso, por ejemplo: 'Gestor'
  • notificar (verdadero o falso) - si el contacto debe ser notificado sobre eventos importantes (esto ha sido reemplazados por Alertas)
  • administrador - si al contacto se le permite administrar este recurso
  • contactoPrincipal - si el contacto es el contacto principal para este recurso

El formulario de la url es https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/{contact id}

PUT igual como POST.

DELETE se eliminará el contacto de un recurso.

El cuerpo debe ser una llamada json válida y usted debe especificar al menos estas propiedades:

  • usuario - el nombre de la aplicación que está solicitando la actualización; y
  • api_key - una clave válida para verificar que está autorizado para modificar el recurso.

La dirección url tiene la misma forma que el anterior.

Intercambio de metadatos EML

El registro ofrece un servicio para extraer metadatos del recursos en formato EML. La respuesta se forma con Esquema EML de GBIF. Este documento es adecuado para su inclusión en un Darwin Core Archive como la descripción de metadatos de los archivos contenidos. La forma es:

GET https://collections.ala.org.au/ws/eml/{uid}
Este ejemplo de uri devuelve un documento XML que describe el conjunto de registros de ocurrencia para la DECCW Atlas de NSW Wildlife: https://collections.ala.org.au/ws/eml/dr368

Servicios de citación

Los servicios de citación devuelven información sobre la atribución y la licencia para registros digitalizados que se pueden acceder a través del Atlas.

Citas para obtener una lista de proveedores de datos

Este servicio acepta una lista de UIDs de entidad y devuelve la información de la citación para cada entidad. Puede especificar cualquier tipo de entidad, pero sólo los recursos de datos tienen información significativa de la citación. Para cada entidad, el servicio devuelve el nombre de la entidad, su texto de la citación, el texto de sus derechos y una cadena de 'más información' que contiene un enlace a la página de laentidad en collectory . La forma es:

GET https://collections.ala.org.au/ws/citations/{listOfUIDs}
donde listaDeUIDs es una lista de UID separada por comas.
Este ejemplo de uri devuelve una lista de citas para los tres recursos de datos especificados: https://collections.ala.org.au/ws/citations/dr368,dr105,dr357

El servicio puede devolver los datos como una lista JSON o un archivo CSV o TSV con las cabeceras apropiadas. El formato se especifica mediante http content-negotiation.
Más información.

Servicios de búsqueda

Estos servicios apoyan las inter-operaciones con otros componentes del Atlas como el bio-cache y el BIE. No todos los servicios cumples los principios RESTful pero se están refactorizando para que puedan ser usados.

Mapea un registro del bio-cache para una colección

Este servicio coge un código de colección y de institución de un registro y mapas de la combinación de una sola colección. La forma es:

GET https://collections.ala.org.au/lookup/inst/{institution-code}/coll/{collection-code}
Este ejemplo uri devuelve los metadatos para la Colección de Insectos Nacional Australiana: https://collections.ala.org.au/lookup/inst/ANIC/coll/Insects
More information.

Recibe un resumen para una entidad

Este servicio sólo devuelve un subconjunto de los metadatos de una entidad. La forma es:

GET https://collections.ala.org.au/lookup/summary/{uid}
Este ejemplo de uri devuelve los metadatos para el proveedor de datos de Aves de Australia: https://collections.ala.org.au/lookup/summary/dp28

Los servicios de resumen son menos útiles ahora que tenemos servicios de metadatos full RESTful pero se mantienen por compatibilidad con versiones anteriores. También ofrecen una eficacia pequeña cuando el servicio se llama repetidamente como durante las operaciones de indización. Más información.

Búsqueda el nombre de una entidad

Este servicio es aún más corto que el resumen. Devuelve sólo el nombre de una entidad dada su UID. La forma es:

GET https://collections.ala.org.au/lookup/name/{uid}

Más información.

Obtener sugerencias para la cobertura taxonómica para una entidad

Este servicio juega un rol en el emparejamiento taxonómico de nombres durante el proceso de listado de regitros en el bio-cache. Cuando un registro ha sido asignado a una colección, los metadatos de la colección pueden utilizarse para informar al proceso de emparejamiento agregando un peso a los mapeos dentro de determinados grupos taxonómicos. La forma es:

GET https://collections.ala.org.au/lookup/taxonomicCoverageHints/{uid}
Este ejemplo de uri devuelve una lista de pares de nombres de rango que describen un rango taxonómico: https://collections.ala.org.au/lookup/taxonomyCoverageHints/co12
More information.

Lista los límites de descarga para todos los recursos de datos

Pueden aplicarse límites al número de registros que puede descargarse desde un recurso particular por petición. If [ ] es devuelto, no existen límites establecidos actualmente. La forma es:

GET https://collections.ala.org.au/lookup/downloadLimits

Generar UID para una nueva entidad

Este es un servicio temporal utilizado cuando se descubren nuevos recursos de datos durante la recolección de registros. Este servicio va a desaparecer cuando el proceso de cosechando sea refactorizado. Los servicios estándar de datos se utilizará para crear el nuevo recurso y devolver el UID asignado por el collectory. La forma es:

GET https://collections.ala.org.au/lookup/generateDataResourceUid

Más información.