| ID | SCHEDULE |
|---|---|
| Method | GET |
| URI |
|
| Embargo Data | No |
| Requires authentication | No |
| Description | Full Snapshots of the effective data in each entity are taken on the first of every month. This table has one row per snapshotted month and a unique code that helps the user filter the other tables to just a single month's data (generally Datamart users are only interested in the latest/currently effective month). The datamart will contain a rolling window of 12 previous and 1 current snapshot months to ensure that the details of recently delisted but still dispenable items are discoverable |
Parameters
| Parameter | Description | Default | Required | Example |
format |
specifies the output format | JSON | false | ?format=csv |
include_header |
specifies whether a header is included in the results. Note: only works for CSV output formats. | false | false | ?include_header=true |
download |
specifies whether the request should prompt a download response in the user's browser (Chrome compatible) | false | false | ?download=true |
SCHEDULE_CODE |
Schedule Code is a unique identifier given to each month's Schedule. By having a Schedule Code in each table, 13 months (schedules) worth of data can be maintained in the Data Mart to assist users in the identification of Delisted Items and change-over-time. In order to see what year/month/effective date a schedule code refers to, look it up in the SCHEDULE_T table | false | ?SCHEDULE_CODE=**exampleValue** |
|
EFFECTIVE_DATE |
The Specifc date for which the data mart is valid | false | ?EFFECTIVE_DATE=**exampleValue** |
|
EFFECTIVE_MONTH |
The specific month for which the data mart is valid | false | ?EFFECTIVE_MONTH=**exampleValue** |
|
EFFECTIVE_YEAR |
The specific year for which the data mart is valid | false | ?EFFECTIVE_YEAR=**exampleValue** |
|
LATEST_SCHEDULE_INDICATOR |
This indicates whether the Schedule is the latest Schedule. By joining all tables to the Schedule Table by Schedule Code where the Latest_Schedule_Indicator = 'Y', the user can easily restrict the datamart to the latest version of the data. | false | ?LATEST_SCHEDULE_INDICATOR=**exampleValue** |
Example
curl -d https://aucapiapppbspilot.azurewebsites.net/SCHEDULE?format=csv&include_header=true&schedule_code=2710
Sample Response
Get November 2020 Schedule's SCHEDULE data in CSV format
https://aucapiapppbspilot.azurewebsites.net/SCHEDULE?format=csv&include_header=true&schedule_code=2710
Sample output:
**insert here**
Created on , last edited on 7/12/2020