Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.06 KB

README.md

File metadata and controls

33 lines (26 loc) · 2.06 KB

GeoNet NZ Logo GeoNet New Zealand API for Java and Android

API Library written in Java for GeoNet NZ to access information on earthquakes and volcanoes. Please ensure you have read and understood GeoNet NZ's Data Policy and Disclaimer before using any of these services.

The API is designed to match the documentation on the GeoNet API official documentation, hence I will not write my own documentation, although javadocs within the code have been created.

Dependencies

  • com.squareup.retrofit2:retrofit2:2.4.0 - RESTful Client used to access the Web Service.
  • com.squareup.retrofit2:converter-gson:2.4.0 - Transforms JSON data into Java Objects.
  • com.tickaroo.tikxml:annotation:0.8.13 - Transforms XML data in Java Objects.
  • com.tickaroo.tikxml:core:0.8.13 - - Transforms XML data in Java Objects.
  • com.tickaroo.tikxml:processor:0.8.13 - Transforms XML data in Java Objects. Annotation processing must be enabled in IDE.
  • junit:junit:4.12 - Unit testing.

Why TikXML?

Although SimpleXML is more well known and the API is well-documented, it is deprecated when used with Retrofit2 due to the number of CVEs, hence why I chose to use an alternative XML parser, known as TikXML. Its quite similar to SimpleXML, and has other advantages, such as less memory usage and has faster processing.

For more documentation on TikXML, click here

Issues

My CAD-related Calls are not working

Although both the Quake CAD Feed and Quake CAD calls exists in the library, they will not work if a feed item exists. At the moment it is unclear how feed items are presented in XML, hence I cannot complete the CAD model classes. Additionally, the API documentation is very vague on the output expected.

Tragically, I guess I have to wait for a major earthquake to finish coding these API calls.

Upcoming

  • Possibly GeoNet FITS API