Partilhar via

DPIRD Radar - West Australia (Independent Publisher) (Preview)

  • Reference

Allows you to integrate the DPIRD RADAR estimated rainfall data within your applications

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Paul Culmsee
URL https://www.sevensigma.com.au
Email paul.culmsee@sevensigma.com.au
Connector Metadata
Publisher Paul Culmsee
Website https://www.agric.wa.gov.au/
Privacy Policy https://www.agric.wa.gov.au/apis/api-terms-and-conditions
Categories Business Intelligence; Data

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get Nearby Radar

Get nearest radar points to a latitude and longitude
Get Radar

Get metadata for a specific radar
Get Radar Daily Summaries

Get the daily summaries for a latitude and longitude based on the closest radar point
Get Radar Monthly Summaries

Get the monthly summaries for a latitude and longitude based on the closest radar point
Get Radar Rainfall

Get the rainfall for specific radars
Get Radars

Returns a list of radars and their metadata.

Get Nearby Radar

Operation ID:
GetNearbyRadar

Get nearest radar points to a latitude and longitude

Parameters

Name Key Required Type Description
Latitude
 latitude True number

A latitude in decimal format.
Longitude
 longitude True number

A longitude in decimal format.
BOM Rainfields dataset
 dataSet string

Select the BOM Rainfields dataset to use. Case sensitive.

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
collection
 collection array of radarLocationModel

Information about a radar point.

Get Radar

Operation ID:
GetRadar

Get metadata for a specific radar

Parameters

Name Key Required Type Description
Radar Code
 radarCode True string

A single case-sensitive radar code.
Fields to include in the result
 select string

A comma separated list of fields to include in the result. Note that this will not include radar codes or names unless explicitly included

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
collection
 collection array of radarMetadataModel

collection

Get Radar Daily Summaries

Operation ID:
GetRadarDailySummaries

Get the daily summaries for a latitude and longitude based on the closest radar point

Parameters

Name Key Required Type Description
Start Date
 startDate True string

The start date in YYYY-MM-DD format
End Date
 endDate True string

The end date in YYYY-MM-DD format
Latitude
 latitude True number

A latitude in decimal format.
Longitude
 longitude True number

A longitude in decimal format.
BOM Rainfields dataset
 dataSet string

Select the BOM Rainfields dataset to use. Case sensitive.
Fields to include in result
 select string

A comma separated list of fields to include in the result. Note that this will not include radar codes or names unless explicitly included.
Query Offset
 offset integer

The pagination offset parameter specifies the first entry to return from a collection.
Number of records to retrieve
 limit integer

The pagination limit parameter restricts the number of entries returned.
Fields to sort by
 sort string

A comma separated list of fields to sort by. Defaults to ascending. Prepend '-' for descending. For wind fields you can only sort or select by the lowest sensor.

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
radar
 data.radar radarLocationModel2

details of the radar point used to generate the estimate
summaries
 data.summaries array of rainfallSummaryModel

summaries

Get Radar Monthly Summaries

Operation ID:
GetRadarMonthlySummaries

Get the monthly summaries for a latitude and longitude based on the closest radar point

Parameters

Name Key Required Type Description
Start Month
 startMonth True string

The start date in YYYY-MM format
End Month
 endMonth True string

The end date in YYYY-MM format
Latitude
 latitude True number

A latitude in decimal format.
Longitude
 longitude True number

A longitude in decimal format.
BOM Rainfields dataset
 dataSet string

Select the BOM Rainfields dataset to use. Case sensitive.
Fields to include in result
 select string

A comma separated list of fields to include in the result. Note that this will not include radar codes or names unless explicitly included.
Query Offset
 offset integer

The pagination offset parameter specifies the first entry to return from a collection.
Number of records to retrieve
 limit integer

The pagination limit parameter restricts the number of entries returned.
Fields to sort by
 sort string

A comma separated list of fields to sort by. Defaults to ascending. Prepend '-' for descending. For wind fields you can only sort or select by the lowest sensor.

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
radar
 data.radar radarLocationModel2

details of the radar point used to generate the estimate
summaries
 data.summaries array of rainfallSummaryModel

summaries

Get Radar Rainfall

Operation ID:
GetRadarRainfall

Get the rainfall for specific radars

Parameters

Name Key Required Type Description
Latitude
 latitude True number

A latitude in decimal format.
Longitude
 longitude True number

A longitude in decimal format.
Radar code(s)
 radarCode string

A comma separated list of case-sensitive radar codes. Limits the radars which will be returned.
BOM Rainfields dataset
 dataSet string

Select the BOM Rainfields dataset to use. Case sensitive.
Fields to include in the result
 select string

A comma separated list of fields to include in the result. Note that this will not include radar codes or names unless explicitly included.
Query Offset
 offset integer

The pagination offset parameter specifies the first entry to return from a collection.
Number of records to retrieve
 limit integer

The pagination limit parameter restricts the number of entries returned.
Fields to sort by
 sort string

A comma separated list of fields to sort by. Defaults to ascending. Prepend '-' for descending. For wind fields you can only sort or select by the lowest sensor.

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
data
 data rainfallModel

data

Get Radars

Operation ID:
GetRadars

Returns a list of radars and their metadata.

Parameters

Name Key Required Type Description
Radar code(s)
 radarCode string

A comma separated list of case-sensitive radar codes. Limits the radars which will be returned.
Query Offset
 offset integer

The pagination offset parameter specifies the first entry to return from a collection.
Number of records to retrieve
 limit integer

The pagination limit parameter restricts the number of entries returned.
Fields to sort by
 sort string

A comma separated list of fields to sort by. Defaults to ascending. Prepend '-' for descending. For wind fields you can only sort or select by the lowest sensor.
Fields to include in the result
 select string

A comma separated list of fields to include in the result. Note that this will not include radar codes or names unless explicitly included

Returns

Name Path Type Description
metadata
 metadata apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.
collection
 collection array of radarMetadataModel

collection

Definitions

apiMetaDataModel

A wrapper on all responses providing useful information related to the API call.

Name Path Type Description
status
 status integer

status
links
 links linksModel

A series of links related to the endpoint.
collection
 collection paginationModel

Pagination details

radarMetadataModel

Name Path Type Description
code
 code string

This is the unique case-sensitive radar code.
location
 location string

The location of the radar.
state
 state string

The Australian state or territory the radar covers.
online
 online boolean

Informational field indicating the ongoing status of a radar. This is set manually by DPIRD depending on the availability of the radar from BOM.
offlineReason
 offlineReason string

The reason the radar has been set offline. Null if radar is online.
bounds
 bounds array of array

Two latitude-longitude pairs that make up the radar's boundaries.
items
 bounds array of float

radarLocationModel

Name Path Type Description
radarCode
 radarCode string

This is the unique case-sensitive radar code.
latitude
 latitude float

The latitude of the radar point.
longitude
 longitude float

The longitude of the radar point.
dataSet
 dataSet string

The BOM Rainfields dataset used
distance
 distance integer

The distance from the supplied latitude / longitude pair in meters.

rainfallModel

data

Name Path Type Description
dateTime
 dateTime string

dateTime
code
 radar.code string

code
latitude
 radar.latitude float

A latitude that will be used to find the nearest radar point.
longitude
 radar.longitude float

A longitude that will be used to find the nearest radar point.
distance
 radar.distance integer

distance
dataSet
 radar.dataSet string

dataSet
currentHour
 rainfall.currentHour integer

currentHour
monthToDate
 rainfall.monthToDate float

monthToDate
yearToDate
 rainfall.yearToDate float

yearToDate

rainfallSummaryModel

Name Path Type Description
from
 period.from string

The start of the specified interval in UTC. The time returned for the monthly and yearly interval will be midnight at the start of the calendar month/year.
to
 period.to string

The end of the specified interval in UTC. The time returned for the monthly and yearly interval will be midnight at the start of the calendar month/year.
year
 period.year integer

This is the year value that the summary relates to.
month
 period.month integer

This is the month value that the summary relates to.
day
 period.day integer

This is the day of the month that the summary relates to.
hour
 period.hour integer

This is the 24-hour value that the summary relates to.
period.minute integer

This is the minute value that the summary data relates to. In case of a 15 minute or 30 minute interval, the minute value will represent the end of the interval.
rainfall float

The estimated monthly rainfall

radarLocationModel2

details of the radar point used to generate the estimate

Name Path Type Description
code
 code string

The code of the radar used to create the estimate
latitude
 latitude float

The latitude of the radar point used to create the estimate
longitude
 longitude float

The longitude of the radar point used to create the estimate
distance
 distance integer

The distance in meters from the requested lat/long to the radar point used.

paginationModel

Pagination details

Name Path Type Description
count
 count integer

count
limit
 limit integer

limit
offset
 offset integer

offset
links
 links linksModel

A series of links related to the endpoint.

linksModel

A series of links related to the endpoint.

Name Path Type Description
URL
 href string

Specifies the URL of the page the link goes to.
Relationship
 rel string

Specifies the relationship between the current document and the linked document.