FAQ

Frequently Asked Questions on AEIP applications, tools and products.

API

How do I get an Exposure Report API key?


An Exposure Report API key can be requested by simply emailing: aeip@ga.gov.au

An API Key acts as both a unique identifier and an authorisation token to allow applications to access the Exposure Report capability. Developers require a key to connect custom applications and/or existing systems.




What is an API?


API stands for Application Programming Interface. In computer programming, an API enables developers to use, or incorporate an existing set of tools, protocols, routines directly in their own application or interface system.

The Exposure Report API allows software developers to access the same functionality used by the Exposure Report mapping application to create exposure reports, within their own custom applications and/or existing systems.




Where can I access the Exposure Report API Documentation?


The API Documentation can be found by either:

Accessing the documentation directly at: https://api-doc.aeip.ga.gov.au/index.html




What are the restrictions for the area of interest?


The area of interest must be:

  • a single closed or multipart polygon
  • within a single state/territory boundary
  • less than 250,000,000ha





Exposure Outputs

What does an exposure report look like?


The compressed file emailed to you (via a download link) includes your custom Exposure Report as both a HTML file and Microsoft Excel spreadsheet.

The HTML file (double clicked) will open in your default browser, and looks like a report document. This can subsequently be printed to PDF or printed as a hardcopy if required.

The spreadsheet contains the same information in the HTML file; however its format is better suited for additional analysis.

Metadata and a map displaying your requested area of interest, is included in both documents for reference.

An example of a Geoscience Australia Exposure Report outputs is located at: View example Exposure Report




Where can I find more about where the data is sourced from?


The Geoscience Australia Exposure Report Product Description document provides a detailed breakdown of definitions, methodologies, calculations, data sources, etc. This will help you to understand what is involved in capturing each exposure element.

The Geoscience Australia Exposure Report Product Description document Version 4.0 is located at: View Exposure Report Product Description Document




Can I access the spatial data?


The underlying spatial data used to create and provide the information in the exposure report is not all publically available due to licensing restriction on the source data. However, those datasets and web services which are available can be access from Geoscience Australia website.

Geoscience Australia web service, or downloaded can be access from our data catalogue: Geoscience Australia Data Catalogue




How do I get/print a PDF version of the exposure report?


Preform the following steps to create a PDF or print your downloaded Exposure Report:

  • Open the HTML included in the downloaded zip file

  • Use the print tools within the browser to print or create a PDF (i.e. 'Print to PDF')

  • Ensure background graphics is enabled (required for all browsers - see below)

Chrome:

  • Click 'More settings'

  • Under 'Options', ensure 'Background graphics' is checked on

Internet Explorer:

  • In Page Setup, ensure 'Print Background Colours and Images' is checked on

  • Ideally use the settings below, as they will ensure the document retains the correct colours and content fits correctly.

All browsers have a similar option to print background images/colours, in their print settings. If you have tried the above suggestions and still experiencing issues, please contact: aeip@ga.gov.au





Mapping Application

What can I do with the exposure report mapping application?


Use the Exposure Report mapping application tools to explore and define your area of interest. The application includes a map and spatial features, of which you can pan, zoom, view additional information, measure areas and distances, search for locations, create bookmarks, etc.

The ‘Create Exposure Report’ tool allows you to upload; draw or select an existing administrative area to request your own custom Exposure Report. When you have completed the form and submitted your information, a link to your report will be emailed to you.




How long does it take to receive an exposure report?


Depending on the size and complexity of the area of interest, an exposure reports is generally emailed to your account within 5 minutes.

To ensure the application will return a result:

  • The uploaded area of interest must be less than 10mb
  • The area of interest cannot exceed 250,000,000ha.

If you have not received an email containing your area of interest Exposure Report within 30 minutes, email: aeip@ga.gov.au




Can I run multiple areas of interest at the same time?


No. The exposure request process is currently setup for an individual area (a single polygon) at one time.

The upload zipped shapefile must only contain a single polygon feature. The area of interest can contain multiple polygons but all polygons must be merged into a single polygon record for the process to run successfully. Similarly, the draw tool will only allow you to draw a single area/polygon to submit to receive an exposure report.




What is a zipped shapefile?


A shapefile is a file format for storing spatial vector data. A shapefile is actually comprised of multiple individual files, including .shp, .dbf, .shx, .prj, .sbn, .sbx, .shp.xml.

When using a zipped shapefile as your area of interest, you need to include as a minimum the .shp, .dbf, and .shx files.

The files must be directly in the compressed folder, and cannot be within a folder that’s in a compressed folder. This can be achieved in windows explorer, by selecting the individual files, right click and select ‘Send to’, then ‘Compressed (zipped) folder’.

If you have any questions or issues related to using a shapefile, please post in the forum or email: aeip@ga.gov.au




How do I create my own exposure report?


Custom Exposure Reports can easily be generated using the GA Web Mapping Application, found by either:

Within the Web Map, you can request a report by using the ‘Create Exposure Report’ tool:

Step 1 - Select from drop down menu

Step 2 – (Free text) Type a name for the event which the exposure report is for.

Step 3 - Upload, Draw or Select your Area of Interest

Step 4 – (Free text) Type the name for the source of area of interest

Step 5 - Select preferred exposure themes (at least one needs to be selected)

Step 6 - Provide an Email address to receive your request.

Click ‘Submit request’

If your request has all the required information, you will receive an email in 5-10 minutes with a link to the report.

If any of the steps turn RED or an error received after submission, please correct and re-submit.




I am having issues viewing the map or using the tools?


Please ensure your browser is HTML5 compatible. The recommended browser is Chrome, however Firefox or Microsoft Edge are also suitable options.

If you are still having issues, please:

  • check the AEIP forum for any known issues or updates
  • post questions or issues on the forum
  • or email: aeip@ga.gov.au




What are the restrictions for the area of interest?


The area of interest must be:

  • a single closed or multipart polygon
  • within a single state/territory boundary
  • less than 250,000,000ha





General

What does 'Exposure' mean? What is Exposure?


Exposure refers to the elements at risk from a natural or man-made hazard event. This could include: individuals; dwellings or households, communities; buildings and structures; public facilities and infrastructure assets; agricultural commodities; environmental assets; and business activity.




What does 'Exposure Information' mean?


Exposure information is the location and characteristics, or attributes, of each of the elements which help identify who and what is at risk. Characteristics include structural (construction year, wall and roof materials, building size), economic (construction and replacement cost value) and demographic (population and social vulnerability indicators) which help indicate who and what is at risk.




Who would use the Exposure Reports?


Anyone can use the Exposure Report. Although originally created for the emergency management audience, the Exposure Reports create a community profile of the AOI which can be used by researchers, town planners, insurance, etc.




What are Exposure Themes?


The Exposure Themes are Agriculture, Building, Business, Environment, Infrastructure and Institution. They are defined to categorise the Exposure Elements and to assist the user in creating an Exposure Report with only the information they require.




Does the Exposure Reports contain personal information?


No.

Exposure information is produced by sourcing the best publicly available information, statistics, spatial and survey data about buildings, demographics, community infrastructure and agricultural commodities.

Australian Bureau of Statistics (ABS) Population and Housing Census provide demographic statistics at SA1 or SA2 level and dwelling type where available for census periods. For any AOI containing twenty (20) or less dwellings, demographic and some building information is not displayed because exposure information at small aggregations becomes meaningless. Exposure Reports are not for operational purposes and do not contain personal information.




What is an Exposure Report?


The Exposure Report presents exposure information located within a user-define Area of Interest (AoI) in a clear and easily accesible report. It consists of a location map, lists of LGAs and Localities within the AoI and tables categorised by user-defined exposure themes: Agriculture, Building, Business, Environment, Infrastructure, and, Institution. View example Exposure Report