| ID | RESTRICTION_TEXT |
|---|---|
| Method | GET |
| URI |
|
| Embargo Data | No |
| Requires authentication | No |
| Description | This table contains the text for restrictions, notes and cautions required in the legislative instruments - HTML formatted |
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 |
RES_CODE |
This is a unique and persistent identifier to identify the Restriction, Caution or Note | false | ?RES_CODE=**exampleValue** |
|
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** |
|
TREATMENT_OF_CODE |
Treatment of Code maps directly to the legal instrument text of a restriction. That is all restriction text except forwards, notes and cautions. | false | ?TREATMENT_OF_CODE=**exampleValue** |
|
RESTRICTION_NUMBER |
A Restriction Number is a number designated to a version of a Restriction when it is created. It will change as the underlying Prescribing Texts are modified | false | ?RESTRICTION_NUMBER=**exampleValue** |
|
LI_HTML_TEXT |
This is the HTML formatted, fully qualified Resitriction Text or Prescribing Text for the given Restriction, Note or Caution | false | ?LI_HTML_TEXT=**exampleValue** |
|
NOTE_INDICATOR |
Indicates that the text is a Note | false | ?NOTE_INDICATOR=**exampleValue** |
|
CAUTION_INDICATOR |
Indicates that the text is a Caution | false | ?CAUTION_INDICATOR=**exampleValue** |
Example
curl -d https://aucapiapppbspilot.azurewebsites.net/RESTRICTION_TEXT?format=csv&include_header=true&schedule_code=2710
Sample Response
Get November 2020 Schedule's RESTRICTION_TEXT data in CSV format
https://aucapiapppbspilot.azurewebsites.net/RESTRICTION_TEXT?format=csv&include_header=true&schedule_code=2710
Sample output:
**insert here**
Created on , last edited on 7/12/2020