Partager via


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

This API provides the back-end to the Rainfall to Date, Potential Yield, and Soil Water tools already available on the DPIRD website

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 Potential Yield

Get Potential Yield

Get Single Station

Get the metadata for a specific station

Get Single Station Rainfall

Returns the rainfall to date, historical rainfall data, and projected rainfall data, depending on already received rainfall

Get Soil Water

Returns the amount of water in the soil depending on the rainfall received and the type of soil.

Get Stations

Returns a list of stations that can be used with the Science API.

Get Stations Nearby

Returns a list of nearby stations, sorted by distance. Use paging to control the number of stations returned. Returns 5 stations by default. Sorted by distance from location ascending.

Get Yellow Spot

Run the Moin or Chris Yellow Spot model.

Get Potential Yield

Get Potential Yield

Parameters

Name Key Required Type Description
Station Code
stationCode string

A single case-sensitive station code.

Latitude
latitude number

The latitude to search by in decimal degrees.

Longitude
longitude number

The longitude to search by in decimal degrees.

Summer Start Date
summerStartDate date

The date that summer starts on. Defaults to 1/11 of the previous year

Growing Season Start Date
growingSeasonStartDate date

The date that the growing season starts. Defaults to 1/4 of the current year.

Growing Season End Date
endDate date

The end date for the growing season. Defaults to 31/10 of the current year.

Forecast Date
forecastDate date

The date to conduct the projections from. Can be used to see historical predictions. Defaults to the current date.

The water use efficiency to use.
waterUseEfficiency integer

The water use efficiency to use.

The evaporation.
evaporation integer

The evaporation.

Returns

Name Path Type Description
metadata
metadata apiMetaDataModel

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

data
data potentialYieldModel

Potential yield data

Get Single Station

Get the metadata for a specific station

Parameters

Name Key Required Type Description
Station Code
stationCode True string

A single case-sensitive station code.

Returns

Name Path Type Description
metadata
metadata apiMetaDataModel

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

data
data stationModel

Get Single Station Rainfall

Returns the rainfall to date, historical rainfall data, and projected rainfall data, depending on already received rainfall

Parameters

Name Key Required Type Description
Station Code
stationCode True string

A single case-sensitive station code.

Summer Start Date
summerStartDate date

The date that summer starts on. Defaults to 1/11 of the previous year

Growing Season Start Date
growingSeasonStartDate date

The date that the growing season starts. Defaults to 1/4 of the current year.

Growing Season End Date
endDate date

The end date for the growing season. Defaults to 31/10 of the current year.

Forecast Date
forecastDate date

The date to conduct the projections from. Can be used to see historical predictions. Defaults to the current date.

Fields to Include
select string

A comma separated list of fields to include in the result. Note that this will not include station 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.

data
data stationRainfallModel

Get Soil Water

Returns the amount of water in the soil depending on the rainfall received and the type of soil.

Parameters

Name Key Required Type Description
Station Code
stationCode string

A single case-sensitive station code.

Latitude
latitude number

The latitude to search by in decimal degrees.

Longitude
longitude number

The longitude to search by in decimal degrees.

Start date
startDate True string

The start date for the period.

End date
endDate True string

The end date for the period.

Soil Code
soilType True string

A code for a type of soil

Crop initialization period
faoInitialisationDays integer

Number of days in crop initialization period, used in the estimation of crop evapotranspiration.

Crop evaporation initialization period
faoInitialisationCropCoefficient number

Proportion of potential evaporation used by crop during initialization period

Days in crop development
faoDevelopmentDays integer

Number of days in crop development period, used in the estimation of crop evapotranspiration.

Crop evaporation development period.
faoDevelopmentCropCoefficient number

Proportion of potential evaporation used by crop during development period.

Days in crop mid-season
faoMidSeasonDays integer

Number of days in crop mid-season period, used in the estimation of crop evapotranspiration.

Crop evaporation mid-season period
faoMidSeasonCropCoefficient number

Proportion of potential evaporation used by during mid-season period

Days in crop late-season
faoLateSeasonDays integer

Number of days in crop late-season period, used in estimation of crop evapotranspiration.

Crop evaporation late-season period.
faoLateSeasonCropCoefficient number

Proportion of potential evaporation used by crop during late-season period.

Rainfall (mm) after April 25th
faoBreakOfSeason3Days25April integer

The number of mm of rainfall after April 25th which triggers the break of the season.

Rainfall (mm) after June 5th
faoBreakOfSeason3Days5June integer

The number of mm of rainfall after June 5th which triggers the break of the season.

Returns

Name Path Type Description
metadata
metadata apiMetaDataModel

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

data
data soilWaterModel

Soil water data

Get Stations

Returns a list of stations that can be used with the Science API.

Parameters

Name Key Required Type Description
Station codes
stationCode string

A comma separated list of case-sensitive station codes. Limits the stations 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
select string

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

Station group
group string

Filter the stations to a predefined group. These need to be supported on the back end. 'all' returns all stations, 'api' returns the default stations in use with the API, 'web' returns the list in use by the weather.agric.wa.gov.au and 'rtd' returns stations with scientifically complete datasets.

Available values are 'all', 'wa', 'sa', 'nsw', 'vic', 'qld', 'tas', 'nt'
state string

Filter by state. By default, all states are returned.

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 stationModel

Collection of Stations

Get Stations Nearby

Returns a list of nearby stations, sorted by distance. Use paging to control the number of stations returned. Returns 5 stations by default. Sorted by distance from location ascending.

Parameters

Name Key Required Type Description
Latitude
latitude True number

The latitude to search by in decimal degrees.

Longitude
longitude True number

The longitude to search by in decimal degrees.

Search Radius
radius integer

Only look for stations within this kilometer range. Defaults to 100km.

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
select string

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

Station group
group string

Filter the stations to a predefined group. These need to be supported on the back end. 'all' returns all stations, 'api' returns the default stations in use with the API, 'web' returns the list in use by the weather.agric.wa.gov.au and 'rtd' returns stations with scientifically complete datasets.

Available values are 'all', 'wa', 'sa', 'nsw', 'vic', 'qld', 'tas', 'nt'
state string

Filter by state. By default, all states are returned.

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 stationModel

Collection of Stations

Get Yellow Spot

Run the Moin or Chris Yellow Spot model.

Parameters

Name Key Required Type Description
Station Code
stationCode string

A single case-sensitive station code.

The date to run the model for
date string

format YYYY-MM-DD. Defaults to the current day if not provided

Return only a part of the results.
select string

Options are 'moin', 'chris', 'moinMaturation', 'moinModel', 'chrisMaturation', 'chrisModel'. Multiple options can be provided as a comma separated string ie. 'moinMaturation,chrisMaturation'. By default all results are returned.

Returns

Name Path Type Description
metadata
metadata apiMetaDataModel

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

maturation
data.moin.maturation maturationModel

maturation

model
data.moin.model yellowSpotModel

model

maturation
data.chris.maturation maturationModel

maturation

model
data.chris.model yellowSpotModel

model

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

yellowSpotModel

model

Name Path Type Description
date
date string

The date.

minimum
temperature.minimum float

The minimum temperature for the day.

maximum
temperature.maximum float

The maximum temperature for the day.

average
temperature.average float

The average temperature for the day.

movingAverage
temperature.movingAverage float

The moving average.

rain
rainfall.rain float

The daily rainfall for the period

movingSum
rainfall.movingSum float

The rainfall moving sum.

suitable
suitable

Model suitable

maturationProgress
maturationProgress

Model maturation Progress

maturationModel

maturation

Name Path Type Description
date
date string

Calculated date of maturity, if it has occurred.

progress
progress float

Current maturation as percentage of target as of the request date. If request date is the calculated date of maturity this will be 100%; if after it will be larger.

target
target integer

Number of suitable days required to reach maturation.

soilWaterModel

Soil water data

Name Path Type Description
soilWater
soilWater array of object

the soil water data

date
soilWater.date string

The summer start date.

rainfall
soilWater.rainfall float

The amount of rain that fell on the day.

fallow
soilWater.fallow float

The soil water in mm for a fallow paddock.

crop
soilWater.crop float

The soil water in mm for a cropped paddock.

breakOfSeason
breakOfSeason string

Break Of Season

potentialYieldModel

Potential yield data

Name Path Type Description
forecastDate
summary.forecastDate string

forecastDate

inGrowingSeason
summary.inGrowingSeason boolean

inGrowingSeason

startDate
summary.summer.startDate string

The summer start date.

endDate
summary.summer.endDate string

The end of the summer period (the day before the season starts)

cumulativeRainfall
summary.summer.cumulativeRainfall float

The amount of rain that has fallen during the summer period.

decile
summary.summer.decile integer

The historical decile this summers rainfall falls into.

startDate
summary.growingSeason.startDate string

The date the season starts

endDate
summary.growingSeason.endDate string

The date the season ends, or the current date if currently within the season.

cumulativeRainfall
summary.growingSeason.cumulativeRainfall float

The amount of rain that has fallen between the start and end dates.

decile
summary.growingSeason.decile integer

Given the current cumulative rainfall, this is the historical decile the rainfall would fit into.

potentialYield
potentialYield array of object

The potential yield and expected rainfall for the season, by decile.

decile
potentialYield.decile integer

The decile from 1 to 9

projectedRainfall
potentialYield.projectedRainfall float

The projected rainfall for the decile in mm.

potentialYield
potentialYield.potentialYield

The potential yield in tonnes/ha.

stationRainfallModel

Name Path Type Description
forecastDate
forecastDate string

This is the unique case-sensitive weather station code.

startDate
summary.summer.startDate string

The summer start date.

endDate
summary.summer.endDate string

The end of the summer period (the day before the season starts)

cumulativeRainfall
summary.summer.cumulativeRainfall float

The amount of rain that has fallen during the summer period.

decile
summary.summer.decile integer

The historical decile this summers rainfall falls into.

startDate
summary.season.startDate string

The season start date.

endDate
summary.season.endDate string

The date the season ends, or the current date if currently within the season

cumulativeRainfall
summary.season.cumulativeRainfall float

The amount of rain that has fallen between the start and end dates.

decile
summary.season.decile integer

Given the current cumulative rainfall, this is the historical decile the rainfall would fit into.

currentSeasonalRainfall
summary.currentSeasonalRainfall array of object

The season rainfall summary

date
summary.currentSeasonalRainfall.date string

The date the rainfall occurred on.

rainfall
summary.currentSeasonalRainfall.rainfall float

The rainfall that occurred on the given day.

cumulativeRainfall
summary.currentSeasonalRainfall.cumulativeRainfall float

The cumulative rainfall that has occurred so far this season.

projectedSeasonalRainfall
summary.projectedSeasonalRainfall array of object

The projected season rainfall

date
summary.projectedSeasonalRainfall.date string

The date of the projected rainfall.

deciles
summary.projectedSeasonalRainfall.deciles array of object
decile
summary.projectedSeasonalRainfall.deciles.decile integer

The decile from 1 to 9

rainfall
summary.projectedSeasonalRainfall.deciles.rainfall float

The projected rainfall for the decile.

historicalRainfall
summary.historicalRainfall array of object

The historical season rainfall

date
summary.historicalRainfall.date string

The month and day of the historical rainfall deciles.

deciles
summary.historicalRainfall.deciles array of object

The projected rainfall values by decile.

decile
summary.historicalRainfall.deciles.decile integer

The decile from 1 to 9

rainfall
summary.historicalRainfall.deciles.rainfall float

The projected rainfall for the decile.

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.

stationModel

Name Path Type Description
stationCode
stationCode string

The unique identifier for a station. Case sensitive.

stationName
stationName string

The human readable name of the weather station.

latitude
latitude float

Latitude of the weather station in decimal degrees, used for displaying on a map.

longitude
longitude float

Longitude of the weather station in decimal degrees, used for displaying on a map.

owner
owner string

The owner of the weather station.

state
state string

The Australian state the station resides in.

startYear
startYear number

The year the station was started

endYear
endYear boolean

The year the station was turned off. Null if still running.

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.