| ID | CONTAINER |
|---|---|
| Method | GET |
| URI |
|
| Embargo Data | No |
| Requires authentication | No |
| Description | A table that captures all relevant data for the subsidised containers used when preparing extemporaneously prepared benefits |
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 |
CONTAINER_CODE |
PharmCIS unique identifier code for containers | false | ?CONTAINER_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** |
|
CONTAINER_NAME |
Container name required for PBS website and Schedule of Pharmaceutical Benefits. | false | ?CONTAINER_NAME=**exampleValue** |
|
CONTAINER_AMT_NAME |
The Australian Medicines Terminology (AMT) for containers used for extemporaenous ingredients and standard formula preparations | false | ?CONTAINER_AMT_NAME=**exampleValue** |
|
MARK_UP |
The wholesale mark-up for containers | false | ?MARK_UP=**exampleValue** |
|
AGREED_PURCHASING_UNIT |
The agreed unit or quantity that a price will be calculated for an extemporaneous ingredient | false | ?AGREED_PURCHASING_UNIT=**exampleValue** |
|
AVERAGE_EXACT_UNIT_PRICE |
An average of wholesaler unit prices for containers of extemporaneous ingredients. Required for pricing of extemporaneous ingredients for the PBS | false | ?AVERAGE_EXACT_UNIT_PRICE=**exampleValue** |
|
AVERAGE_ROUNDED_UNIT_PRICE |
A rounded price derived from the average of wholesaler unit prices for containers of extemporaneous ingredients. Required for pricing of extemporaneous ingredients for the PBS | false | ?AVERAGE_ROUNDED_UNIT_PRICE=**exampleValue** |
|
CONTAINER_TYPE |
Descriptor in the format 'container:xx-xx' which provides the type of container. Can be: - bottle-dispensing - dropper-glass - dropper-polythene - bottle-poison - jar-screw-cap | false | ?CONTAINER_TYPE=**exampleValue** |
|
CONTAINER_QUANTITY |
The volume that the container can hold, required for the PBS Website and Schedule of Pharmaceutical Benefits | false | ?CONTAINER_QUANTITY=**exampleValue** |
Example
curl -d https://aucapiapppbspilot.azurewebsites.net/CONTAINER?format=csv&include_header=true&schedule_code=2710
Sample Response
Get November 2020 Schedule's CONTAINER data in CSV format
https://aucapiapppbspilot.azurewebsites.net/CONTAINER?format=csv&include_header=true&schedule_code=2710
Sample output:
**insert here**
Created on , last edited on 7/12/2020