July 2014 - API-users - lists.gbif.org

GBIF API deploy, 12th June
by Markus Döring 20 Nov '14

20 Nov '14

Dear GBIF API users, A new API will be deployed later today. Please expect a short downtime in the central European afternoon, we try to keep it minimal. This is a minor updated and all URLs in the new version will remain the same, keeping v0.9. New features included are improved data processing, multimedia support for occurrences and new occurrence search filters based on media type and processing issues. Please also see http://gbif.blogspot.de/2014/05/multimedia-in-gbif.html If you notice problems or need help with the API feel invited to post questions in this list. with thanks, GBIF dev team -- Markus Döring Software Developer Global Biodiversity Information Facility (GBIF) mdoering(a)gbif.org http://www.gbif.org

1 1

GBIF API v1.0 live
by Markus Döring 29 Jul '14

29 Jul '14

Dear GBIF API users, sorry for the far too long downtime today, but the good news is that version 1.0 of the API is finally live now! http://api.gbif.org/v1/ You can find the updated documentation here as usual: http://www.gbif.org/developer The previous v0.9 API URL will still be running up to the end of August, serving the exact same content. Hope you enjoy it. with best wishes, your GBIF dev team Version 1.0 changes: ---------------------------- - remove all underscores from URLs and replace them with camelCase (mainly species & metrics API) - dataset.owningOrganizationKey renamed to dataset.publishingOrganizationKey - use of lists instead of simple strings for email, phone, homepage, position and address for contacts, organization and node in the registry - include issue column in dwca download - search facets use country iso 2letter codes - species & dataset suggest returns minimal information now: http://api.gbif-uat.org/v0.9/species/suggest?q=Dracul - remove reverse geocode & mendeley GBIF articles from our API

2 2

suggestion for improvement
by Wouter Addink 28 Jul '14

28 Jul '14

Hi, a small suggestion for improvement: can you redirect http://api.gbif.org and api.gbif.org/v1 to http://www.gbif.org/developer/summary? currently it gives an 404 error page with wrong information: "Latest API version is http://api.gbif.org.org/v1" (note the org.org) Best, Wouter Addink Manager Software Development ICT Systems Officer Species 2000 T +31 (0)71-7517 364 P.O Box 9517, 2300 RA Leiden, The Netherlands E wouter.addink(a)naturalis.nl, I www.naturalis.nl E tech(a)sp2000.org, I www.catalogueoflife.org

2 2

[External] occurrenceID as a search parameter
by Steve Baskauf 25 Jul '14

25 Jul '14

Both I and the programmer I'm working with have looked through the API documentation and we don't see occurrenceID as a search parameter. That surprised me, since I thought it was a required field. If we could search for it, we could map any assigned occurrenceID to the GBIFID. I'm sure that there is probably some more indirect way to accomplish this (such as retrieving all records that we have provided, but it seems like this ought to be a simple thing to facilitate. Am I missing something? Steve -- Steven J. Baskauf, Ph.D., Senior Lecturer Vanderbilt University Dept. of Biological Sciences postal mail address: PMB 351634 Nashville, TN 37235-1634, U.S.A. delivery address: 2125 Stevenson Center 1161 21st Ave., S. Nashville, TN 37235 office: 2128 Stevenson Center phone: (615) 343-4582, fax: (615) 322-4942 If you fax, please phone or email so that I will know to look for it. http://bioimages.vanderbilt.edu http://vanderbilt.edu/trees

2 1

Dataset registration change in API v1
by Markus Döring 23 Jul '14

23 Jul '14

Hi all, Pensoft has discovered an issue when migrating to the v1 API to programmatically register new datasets. The dataset property "owningOrganizationKey" is now called "publishingOrganizationKey" and still posting the owningOrganizationKey will result in an exception. Please update your registration code to use publishingOrganizationKey instead. For example a simple json post could look like this: curl -i --user USERNAME:PASSWORD -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"installationKey":"d5b61ace-f25c-43bd-9dd0-03486850f90b","publishingOrganizationKey":"750a8724-fa66-4c27-b645-bd58ac5ee010","title":"Saproxylic beetles of the Po plain woodlands, Italy","type":"OCCURRENCE"}' http://api.gbif.org/v1/dataset If you also want to start to automatically register new datasets please get in touch with us and we will setup the right permissions for your GBIF account Thanks to Pensoft for spotting the problem! best, Markus

1 0

GBIF taxon page URLs by scientific name?
by Ken-ichi 22 Jul '14

22 Jul '14

Is there a way to link to a scientific name on the new GBIF? The old one would (and still does) let you link to taxon pages like this http://data.gbif.org/species/Rhus_typhina but the new GBIF seems to require an identifier in the URL. I could just link to http://www.gbif.org/species/search?q=Rhus%20typhina, but I'd rather link directly to the taxon page. Possible?

3 4

download request for with predicate in taxon_keys throws exception
by jorrit poelen 19 Jul '14

19 Jul '14

Hi! When using: curl -i --user USER:PASSWORD -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @filter.json http://api.gbif.org/v1/occurrence/download/request with —— filter.json { "creator”:”USERNAME", "notification_address": [“EMAIL"], "predicate": { "type":"in", "key":"TAXON_KEY", "values":["2440447","5166399", "2269484"] } } —— I am getting a 500 status (see stack trace below). Am I using a valid predicate? thx, -jorrit http://globalbioticinteractions.org — stacktrace — HTTP/1.1 500 Internal Server Error Server: Apache-Coyote/1.1 Content-Type: text/html;charset=utf-8 x-api-url: /v1/occurrence/download/request Transfer-Encoding: chunked Date: Fri, 18 Jul 2014 20:21:20 GMT X-Varnish: 626777577 Age: 0 Via: 1.1 varnish Connection: keep-alive <html><head><title>Apache Tomcat/7.0.39 - Error report</title><style></style> </head><body><h1>HTTP Status 500 - Error building the hive query, attempting to continue</h1><HR size="1" noshade="noshade">type Exception reportmessage Error building the hive query, attempting to continuedescription The server encountered an internal error that prevented it from fulfilling this request.exception <pre>org.gbif.api.exception.ServiceUnavailableException: Error building the hive query, attempting to continue org.gbif.occurrence.download.service.DownloadRequestServiceImpl.create(DownloadRequestServiceImpl.java:207) org.gbif.occurrence.ws.resources.DownloadResource.startDownload(DownloadResource.java:107) org.apache.bval.guice.ValidateMethodInterceptor.invoke(ValidateMethodInterceptor.java:92) sun.reflect.GeneratedMethodAccessor2784.invoke(Unknown Source) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60) com.sun.jersey.server.impl.model.method.dispatch.AbstractResourceMethodDispatchProvider$TypeOutInvoker._dispatch(AbstractResourceMethodDispatchProvider.java:185) com.sun.jersey.server.impl.model.method.dispatch.ResourceJavaMethodDispatcher.dispatch(ResourceJavaMethodDispatcher.java:75) com.sun.jersey.server.impl.uri.rules.HttpMethodRule.accept(HttpMethodRule.java:288) com.sun.jersey.server.impl.uri.rules.ResourceClassRule.accept(ResourceClassRule.java:108) com.sun.jersey.server.impl.uri.rules.RightHandPathRule.accept(RightHandPathRule.java:147) com.sun.jersey.server.impl.uri.rules.RootResourceClassesRule.accept(RootResourceClassesRule.java:84) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1483) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1414) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1363) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1353) com.sun.jersey.spi.container.servlet.WebComponent.service(WebComponent.java:414) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:537) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:708) javax.servlet.http.HttpServlet.service(HttpServlet.java:728) com.google.inject.servlet.ServletDefinition.doService(ServletDefinition.java:263) com.google.inject.servlet.ServletDefinition.service(ServletDefinition.java:178) com.google.inject.servlet.ManagedServletPipeline.service(ManagedServletPipeline.java:91) com.google.inject.servlet.FilterChainInvocation.doFilter(FilterChainInvocation.java:62) com.google.inject.servlet.ManagedFilterPipeline.dispatch(ManagedFilterPipeline.java:118) com.google.inject.servlet.GuiceFilter.doFilter(GuiceFilter.java:113) </pre>root cause <pre>org.gbif.occurrence.download.service.QueryBuildingException: java.lang.reflect.InvocationTargetException org.gbif.occurrence.download.service.HiveQueryVisitor.visit(HiveQueryVisitor.java:355) org.gbif.occurrence.download.service.HiveQueryVisitor.getHiveQuery(HiveQueryVisitor.java:151) org.gbif.occurrence.download.service.DownloadRequestServiceImpl.create(DownloadRequestServiceImpl.java:204) org.gbif.occurrence.ws.resources.DownloadResource.startDownload(DownloadResource.java:107) org.apache.bval.guice.ValidateMethodInterceptor.invoke(ValidateMethodInterceptor.java:92) sun.reflect.GeneratedMethodAccessor2784.invoke(Unknown Source) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60) com.sun.jersey.server.impl.model.method.dispatch.AbstractResourceMethodDispatchProvider$TypeOutInvoker._dispatch(AbstractResourceMethodDispatchProvider.java:185) com.sun.jersey.server.impl.model.method.dispatch.ResourceJavaMethodDispatcher.dispatch(ResourceJavaMethodDispatcher.java:75) com.sun.jersey.server.impl.uri.rules.HttpMethodRule.accept(HttpMethodRule.java:288) com.sun.jersey.server.impl.uri.rules.ResourceClassRule.accept(ResourceClassRule.java:108) com.sun.jersey.server.impl.uri.rules.RightHandPathRule.accept(RightHandPathRule.java:147) com.sun.jersey.server.impl.uri.rules.RootResourceClassesRule.accept(RootResourceClassesRule.java:84) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1483) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1414) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1363) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1353) com.sun.jersey.spi.container.servlet.WebComponent.service(WebComponent.java:414) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:537) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:708) javax.servlet.http.HttpServlet.service(HttpServlet.java:728) com.google.inject.servlet.ServletDefinition.doService(ServletDefinition.java:263) com.google.inject.servlet.ServletDefinition.service(ServletDefinition.java:178) com.google.inject.servlet.ManagedServletPipeline.service(ManagedServletPipeline.java:91) com.google.inject.servlet.FilterChainInvocation.doFilter(FilterChainInvocation.java:62) com.google.inject.servlet.ManagedFilterPipeline.dispatch(ManagedFilterPipeline.java:118) com.google.inject.servlet.GuiceFilter.doFilter(GuiceFilter.java:113) </pre>root cause <pre>java.lang.reflect.InvocationTargetException sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) org.gbif.occurrence.download.service.HiveQueryVisitor.visit(HiveQueryVisitor.java:348) org.gbif.occurrence.download.service.HiveQueryVisitor.getHiveQuery(HiveQueryVisitor.java:151) org.gbif.occurrence.download.service.DownloadRequestServiceImpl.create(DownloadRequestServiceImpl.java:204) org.gbif.occurrence.ws.resources.DownloadResource.startDownload(DownloadResource.java:107) org.apache.bval.guice.ValidateMethodInterceptor.invoke(ValidateMethodInterceptor.java:92) sun.reflect.GeneratedMethodAccessor2784.invoke(Unknown Source) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60) com.sun.jersey.server.impl.model.method.dispatch.AbstractResourceMethodDispatchProvider$TypeOutInvoker._dispatch(AbstractResourceMethodDispatchProvider.java:185) com.sun.jersey.server.impl.model.method.dispatch.ResourceJavaMethodDispatcher.dispatch(ResourceJavaMethodDispatcher.java:75) com.sun.jersey.server.impl.uri.rules.HttpMethodRule.accept(HttpMethodRule.java:288) com.sun.jersey.server.impl.uri.rules.ResourceClassRule.accept(ResourceClassRule.java:108) com.sun.jersey.server.impl.uri.rules.RightHandPathRule.accept(RightHandPathRule.java:147) com.sun.jersey.server.impl.uri.rules.RootResourceClassesRule.accept(RootResourceClassesRule.java:84) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1483) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1414) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1363) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1353) com.sun.jersey.spi.container.servlet.WebComponent.service(WebComponent.java:414) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:537) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:708) javax.servlet.http.HttpServlet.service(HttpServlet.java:728) com.google.inject.servlet.ServletDefinition.doService(ServletDefinition.java:263) com.google.inject.servlet.ServletDefinition.service(ServletDefinition.java:178) com.google.inject.servlet.ManagedServletPipeline.service(ManagedServletPipeline.java:91) com.google.inject.servlet.FilterChainInvocation.doFilter(FilterChainInvocation.java:62) com.google.inject.servlet.ManagedFilterPipeline.dispatch(ManagedFilterPipeline.java:118) com.google.inject.servlet.GuiceFilter.doFilter(GuiceFilter.java:113) </pre>root cause <pre>java.lang.IllegalArgumentException: Search parameter TAXON_KEY is not mapped to Hive org.gbif.occurrence.download.service.HiveQueryVisitor.toHiveField(HiveQueryVisitor.java:137) org.gbif.occurrence.download.service.HiveQueryVisitor.visit(HiveQueryVisitor.java:199) sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) org.gbif.occurrence.download.service.HiveQueryVisitor.visit(HiveQueryVisitor.java:348) org.gbif.occurrence.download.service.HiveQueryVisitor.getHiveQuery(HiveQueryVisitor.java:151) org.gbif.occurrence.download.service.DownloadRequestServiceImpl.create(DownloadRequestServiceImpl.java:204) org.gbif.occurrence.ws.resources.DownloadResource.startDownload(DownloadResource.java:107) org.apache.bval.guice.ValidateMethodInterceptor.invoke(ValidateMethodInterceptor.java:92) sun.reflect.GeneratedMethodAccessor2784.invoke(Unknown Source) sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) java.lang.reflect.Method.invoke(Method.java:606) com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60) com.sun.jersey.server.impl.model.method.dispatch.AbstractResourceMethodDispatchProvider$TypeOutInvoker._dispatch(AbstractResourceMethodDispatchProvider.java:185) com.sun.jersey.server.impl.model.method.dispatch.ResourceJavaMethodDispatcher.dispatch(ResourceJavaMethodDispatcher.java:75) com.sun.jersey.server.impl.uri.rules.HttpMethodRule.accept(HttpMethodRule.java:288) com.sun.jersey.server.impl.uri.rules.ResourceClassRule.accept(ResourceClassRule.java:108) com.sun.jersey.server.impl.uri.rules.RightHandPathRule.accept(RightHandPathRule.java:147) com.sun.jersey.server.impl.uri.rules.RootResourceClassesRule.accept(RootResourceClassesRule.java:84) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1483) com.sun.jersey.server.impl.application.WebApplicationImpl._handleRequest(WebApplicationImpl.java:1414) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1363) com.sun.jersey.server.impl.application.WebApplicationImpl.handleRequest(WebApplicationImpl.java:1353) com.sun.jersey.spi.container.servlet.WebComponent.service(WebComponent.java:414) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:537) com.sun.jersey.spi.container.servlet.ServletContainer.service(ServletContainer.java:708) javax.servlet.http.HttpServlet.service(HttpServlet.java:728) com.google.inject.servlet.ServletDefinition.doService(ServletDefinition.java:263) com.google.inject.servlet.ServletDefinition.service(ServletDefinition.java:178) com.google.inject.servlet.ManagedServletPipeline.service(ManagedServletPipeline.java:91) com.google.inject.servlet.FilterChainInvocation.doFilter(FilterChainInvocation.java:62) com.google.inject.servlet.ManagedFilterPipeline.dispatch(ManagedFilterPipeline.java:118) com.google.inject.servlet.GuiceFilter.doFilter(GuiceFilter.java:113) </pre>note The full stack trace of the root cause is available in the Apache Tomcat/7.0.39 logs.<HR size="1" noshade="noshade"><h3>Apache Tomcat/7.0.39</h3></body></html> ----

2 1

Dataset contacts
by "Holetschek, Jörg" 10 Jul '14

10 Jul '14

Hi guys, I'm using the API to get dataset metadata from the registry (http://api.gbif.org/v0.9/dataset) Each dataset entry has a 'contact' element, which is a list of contacts. Usually, each contact has a certain type. In the given example in the documentation, there are two contacts, each of type ADMINISTRATIVE_POINT_OF_CONTACT: http://api.gbif.org/v0.9/dataset/4fa7b334-ce0d-4e88-aaae-2e0c138d049e/conta… However, paging through the datasets, I hit contacts that somehow look different. For example, they don't have a type, which breaks a script if you want to find the primary administrative contact, for example: http://api.gbif.org/v0.9/dataset/570489ac-e114-4a17-9340-2e01ee7d9ee3/conta… Is that intended? Or is it leftovers from the old registry? Cheers, Jörg ---//------------------------------------------------------------ Jörg Holetschek Coordinator Biodiversity Data Networks Botanic Garden & Botanical Museum Berlin-Dahlem Dept. Biodiversity Informatics Königin-Luise-Str. 6-8, D-14195 Berlin +49 (0)30 838-50150, j.holetschek(a)bgbm.org ------------------------------------------------------------//---

2 2

API v1.0 release
by Markus Döring 08 Jul '14

08 Jul '14

Dear GBIF API users, we are getting close to releasing the final version 1.0 of the GBIF API. If all goes well we will go live later this week. There will be minor changes in the API compared to what is live today, please see below for more details. With the arrival of version 1.0 we will also change the base URL of the API to finally become: http://api.gbif.org/v1/ To give you some time to adapt we will also keep the v0.9 URL running up to the end of August, serving the exact same content. With v1 existing we also promise to keep the API stable. This means we won't rename or remove any REST resources or response properties to be backwards compatible, but we might add new resources to the API to be announced in this list. Bug fixes and additions will result in minor version changes which are not reflected in the API URL, only in the documentation and our Java client code. As usual if you notice problems or need help with the API feel invited to post questions in this list. with thanks, GBIF dev team Version 1.0 changes: ---------------------------- - remove all underscores from URLs and replace them with camelCase (mainly species & metrics API) - dataset.owningOrganizationKey renamed to dataset.publishingOrganizationKey - use of lists instead of simple strings for email, phone, homepage, position and address for contacts, organization and node in the registry - include issue column in dwca download - search facets use country iso 2letter codes - species & dataset suggest returns minimal information now: http://api.gbif-uat.org/v0.9/species/suggest?q=Dracul - remove reverse geocode & mendeley GBIF articles from our API

1 0

Error 503 with Species Web Service
by Urbanowski, Shayne 08 Jul '14

08 Jul '14

Hello- I have a list of 348782 taxonKeys for which I need the canonicalName. I'm using the species web service (http://api.gbif.org/v0.9/species) within a script to get this data. The web service works well for the first 3000 or 4000 records and then throws the following error. Can you assist me in resolving (or working around) this issue. The list of taxonKeys is posted at: ftp://bison.ornl.gov/pub/bison/out/outspecies1of2.txt http://api.gbif.org/v0.9/species/5278064 Error 503 Service Unavailable Service Unavailable Guru Meditation: XID: 1016539404 Varnish cache server Thanks in advance, -- Shayne Urbanowski COMSO - USGS CSAS surbanowski(a)usgs.gov o: 303-202-4299 m: 720-280-3210 http://www.usgs.gov/core_science_systems/csas/

2 1