GBB (WA) REPORT APPLICATION PROGRAMMING INTERFACE (API) VERSION 1.5

Transcription

1 GBB (WA) REPORT APPLICATION PROGRAMMING INTERFACE (API) VERSION 1.5 Published: November 2015

2 IMPORTANT NOTICE Purpose AEMO has prepared this document to provide information about the GBB (WA) report application programming interface, as at the date of publication. Disclaimer This document or the information in it may be subsequently updated or amended. This document does not constitute legal or business advice, and should not be relied on as a substitute for obtaining detailed advice about the Gas Services Information Rules, or any other applicable laws, procedures or policies. AEMO has made every effort to ensure the quality of the information in this document but cannot guarantee its accuracy or completeness. Accordingly, to the maximum extent permitted by law, AEMO and its officers, employees and consultants involved in the preparation of this document: make no representation or warranty, express or implied, as to the currency, accuracy, reliability or completeness of the information in this document; and are not liable (whether by reason of negligence or otherwise) for any statements or representations in this document, or any omissions from it, or for any use or reliance on the information in it. AEMO GBB (WA) Report Application Programming Interface 2

3 CONTENTS 1. INTRODUCTION 6 2. REPORT ACCESS MECHANISM URLs Host Names Report Names URL Examples Security Request Headers HTTP Response Codes Response Headers 9 3. REPORT LISTS URLs Headers JSON Format Example REPORT FORMATS Common Formats Actual Flows Capacity Outlook End User Consumption Nominations and Forecasts Gas Specification Large User Consumption Large User Consumption by Category Linepack Capacity Adequacy Medium Term Capacity GLOSSARY 42 AEMO GBB (WA) Report Application Programming Interface 3

4 TABLES Table 1 GBB URLs 6 Table 2 GBB Host Names 7 Table 3 Report Names 7 Table 4 HTTP Request Headers 9 Table 5 HTTP Responses 9 Table 6 HTTP Response Headers 9 Table 7 Report URLs 10 Table 8 Report List Fields 10 Table 9 Common Report Fields 12 Table 10 Actual Flows 13 Table 11 Actual Flow URLs 13 Table 12 Actual Flow JSON Row Format 14 Table 13 Actual Flow CSV Fields 14 Table 14 Capacity Outlook 17 Table 15 Capacity Outlook URL 17 Table 16 Capacity Outlook JSON Row Format 17 Table 17 Capacity Outlook CSV Format 18 Table 18 End User Consumption 21 Table 19 End User Consumption URL 21 Table 20 End User Consumption JSON Row Format 21 Table 21 End User Consumption CSV Format 22 Table 22 Nominations and Forecasts 24 Table 23 Nominations and Forecasts URL 24 Table 24 Nominations and Forecasts JSON Row Format 24 Table 25 Nominations and Forecasts JSON Row Format 25 Table 26 Nominations and Forecasts CSV Format 25 Table 27 Gas Specification 28 Table 28 Gas Specification URL 28 Table 29 Gas Specification JSON Row Format 28 Table 30 Gas Specification CSV Format 29 Table 31 Large User Consumption 31 Table 32 Large User Consumption URL 31 Table 33 Large User Consumption JSON Row Format 31 Table 34 Large User Consumption CSV Format 32 Table 35 Large User Consumption by Category 34 Table 36 Large User Consumption by Category URL 34 Table 37 Large User Consumption by Category JSON Row Format 34 Table 38 Large User Consumption by Category CSV Format 35 Table 39 Linepack Capacity Adequacy 37 Table 40 Linepack Capacity Adequacy URL 37 Table 41 Linepack Capacity Adequacy JSON Row Format 37 Table 42 Linepack Capacity Adequacy CSV Format 38 Table 43 Medium Term Capacity 39 AEMO GBB (WA) Report Application Programming Interface 4

5 Table 44 Medium Term Capacity URL 40 Table 45 Medium Term Capacity JSON Row Format 40 Table 46 Medium Term Capacity CSV Format 40 AEMO GBB (WA) Report Application Programming Interface 5

6 1. INTRODUCTION This document describes the mechanism and formats for public access to GBB (WA) reports for use with automated systems. This document is intended for a technical audience, specifically, those who may be implementing systems that interface with the GBB (WA). This document contains three major sections. Section 2 covers the mechanism used to obtain lists of available reports and their contents. Section 3 covers obtaining report lists in detail whilst section 4 details the format of reports. 2. REPORT ACCESS MECHANISM The report interface allows a number of operations to be performed, these are: Retrieving a list of generated reports of a particular report type in JSON format; Obtaining the current report of a particular report type in JSON or CSV format; Obtaining the latest report generated on a particular Gas Day in JSON or CSV format; and Obtaining a particular report in JSON or CSV format using its identifier. All URLs must be accessed using the HTTP GET method. Other methods of access are not supported. 2.1 URLs The URLs for reports share a common base URL format. The format of the base URL is shown below. The hostname varies on the GBB (WA) environment being accessed and the report name is the name of one of the available reports. All possible hostname and reportname values are given in sections 2.2 and 2.3 respectively. URLs for listing and retrieving reports are appended to the base URL for the report. The following table lists all report URLs available under the base URL, with placeholders. Table 1 GBB URLs URL current current.csv [id] [id].csv Information List of available reports, up to the last 1000 generated. See Section 3 for details. The latest available report in JSON format. See the section 3.3 for format details for individual reports. The latest available report in CSV format. See the section 4 for format details for individual reports. The report uniquely identified by the supplied id in JSON format. Report ids are obtained through the report listing mechanism described in section 4.1. See the section for format details for individual reports. The report uniquely identified by the supplied id in CSV format. Report ids are obtained through the report listing mechanism described in section 4.1. See the section for format details for individual reports. AEMO GBB (WA) Report Application Programming Interface 6

7 URL [gas day] [gas day].csv [month].csv Information The latest report in JSON format on the gas day specified in the format YYYY-MM-DD. See section 4 for format details of individual reports. The latest report in CSV format on the gas day specified in the format YYYY-MM-DD. See section 4 for format details of individual reports. The latest reports for every day of a specified month. The month is specified in YYYY-MM format. Monthly reports are not available in JSON format and are available only for selected report types. See section 4 for format details and monthly report availability. 2.2 Host Names There are two host names available, one for the GBB (WA) trial environment (for participant testing) and the other for the live Gas Bulletin Board (WA). These hostnames are shown below. Table 2 GBB Host Names Host Name gbbwa.aemo.com.au gbbwa-trial.aemo.com.au Environment The GBB (WA) production system The GBB (WA) trial system for participant testing Note that the trial and production environments were not commissioned at the time of writing. URLs with these hostnames will only return data once these systems are live. 2.3 Report Names Table 3 below contains the report names and descriptions of all reports available in the GBB (WA). Table 3 Report Names Report Name actualflow capacityoutlook enduserconsumption forecastflow gasspecification largeuserconsumption largeuserconsumptionbycategory linepackcapacityadequecy mediumtermcapacity Description Daily actual flows for all connection points on all Pipeline. Seven day Capacity Outlook for Pipelines, Production Facilities and Storage Facilities. Daily consumption by Large User Facilities, users connected to Distribution Systems and other consumption, aggregated by zone. Seven day Nominated and Forecast Flows for Pipeline connection points and Storage Facilities. Daily gas specification information for Production Facilities and Pipelines affected by a Pipeline Impact Agreement (PIA). Actual daily gas consumption for Large User Facilities. Actual daily Large User Facility consumption by gas usage category, aggregated by zone. Three day Linepack Capacity Adequacy forecast for all zones and Storage Facilities. Medium term capacity report containing the periods of reduced capacity for Pipelines and Production Facilities, together with the reduced capacity. AEMO GBB (WA) Report Application Programming Interface 7

8 2.4 URL Examples The following are examples of URLs for the GBB (WA) production environment and the large user consumption report. The URL to obtain the list of available large user consumption reports The URL to obtain the latest large user consumption report in JSON format. The URL to obtain the latest large user consumption report in CSV format. The URL to obtain the specific large user consumption report in JSON format with the identifier 787a9800-b b047-d78f6dd d78f6dd86832 The URL to obtain the specific large user consumption report in CSV format with the identifier 787a9800-b b047-d78f6dd d78f6dd86832.csv The URL to obtain the latest large user consumption report generated for gas day November 22, 2012 in JSON format. The URL to obtain the latest large user consumption report generated for gas day November 22, 2012, in CSV format. The URL to obtain actual flow data for all days in November 2012, in CSV format Security All reports are publically available and as such, no authentication is required to access any of the URLs specified in section 2.1. Although no authentication is required, all report URLs are only available through HTTPS and will not be made available over unsecured HTTP. 2.6 Request Headers The sole HTTP request header is the Range header which limits the amount of data returned when obtaining a list of reports. This header is only used when requesting a list of reports, detailed in section 3. AEMO GBB (WA) Report Application Programming Interface 8

9 Table 4 HTTP Request Headers Header Format Description Range items=[x]-[y] The range of items to return in the response, specified as zero indexed item numbers. For example, to request the first ten items, the value should be: items= HTTP Response Codes Table 5 shows the responses that are returned by the GBB (WA) server in response to report requests. Table 5 HTTP Responses Response Code Meaning 200 Success 400 Bad request. There was an error in the request. Possibilities include an invalid id format or incorrect range header. 404 Not found. Either an invalid URL was specified or a report with the specified identifier does not exist. 500 Internal Server Error. A server error occurred when producing the report. 2.8 Response Headers The following HTTP response codes are returned when the GBB (WA) server returns a successful response. Table 6 HTTP Response Headers Header Format Description Content-Range Content-Type items=[x]-[y]/[z] [mimetype]/[subtype] The zero-based indexes of the items returned, and the total number of items available. This header is only returned when retrieving a list of available reports, as specified in section 3. For example, if the server returned items the first 15 items of 35, the returned value is items=0-14/35 The type of content returned. This can be one of two values: application/json for JSON formatted reports; or text/csv for CSV formatted reports 3. REPORT LISTS The Report List URLs provide lists of reports for specific report types. The type of report is selected by the supplied URL. Report summaries are returned in reverse chronological order by report generation time. The identifiers returned in the report list can be used to retrieve the detail of the report, as specified in section 4. Report summaries are returned in JSON format; there is no mechanism to retrieve report lists in CSV format. Note that only the latest report for a gas day will be returned. Reports generated earlier, for the same gas day will not be returned. 3.1 URLs The URL for retrieving the report list is in the general form below. AEMO GBB (WA) Report Application Programming Interface 9

10 The complete set of available report lists is shown in Table 7 below. Table 7 Report URLs URL Report Daily actual flow Seven day Capacity Outlook Aggregate end user consumption by zone Seven day nominated and forecast flow Daily gas specification Actual daily consumption for large users Actual daily large user consumption by gas usage category Three day Linepack Capacity Adequacy forecast Twelve month medium term Capacity Outlook 3.2 Headers The Range header may be used to specify the rows that are to be returned, as specified in section 2.6. The GBB (WA) server will respond with two headers; the Content-Range header describing the rows returned, and a Content-Type of application/json, as described in section 2.8: 3.3 JSON Format The retuned data is an array of JSON objects containing the following fields: Table 8 Report List Fields Field id asat gasday Description The unique identifier for the report The date and time when the report was generated, in ISO8601 date/time format The Gas Day for which the report was generated, in ISO8601 date format 3.4 Example Sample JSON output from a report list is shown below: [ "id":"f50d d-4e58-8a6f-0a55949f7def", "asat":" t06:00: :00", "gasday":" ", "id":"86503f24-869b-4dab-841b-6d5b7bfd9757", "asat":" t13:40: :00", "gasday":" " ] AEMO GBB (WA) Report Application Programming Interface 10

11 4. REPORT FORMATS This section details all available GBB (WA) reports and the mechanism to obtain a list of reports. The mechanism to obtain a report list is the same for all reports, differing only in the list URL. This is described in section 4.1. All other subsections describe the URLs for specific reports and the fields returned by those reports. Note that the JSON examples shown in this section have been formatted for legibility. The actual JSON returned from the server may differ in whitespace and field order. CSV examples will be representative of field ordering and whitespace that is returned by the server. 4.1 Common Formats This section describes fields that are common across reports. It describes common fields as well as the standard JSON report structure when reports are requested in JSON format Date and Time formats Where dates and times are supplied in a report, they will be supplied in ISO8601 format. The following table shows the formats used for dates and times For dates, the YYYY-DD-MM format is used where: YYYY is the four digit year MM is the two digit month DD is the two digit year of the month For date/time fields, the YYYY-MM-DDTHH:mm:SS.sssZZZZZ where: YYYY is the four digit year MM is the two digit month DD is the two digit year of the month T is the literal T character HH is the two digit hour of day in 24 hour format (00 to 23) mm is the two digit minute in the hour SS is the two digit second sss is the three digit fractional second (i.e. milliseconds) ZZZZZ is the time zone offset from UTC, which will be set to +08:00, representing Australian Western Standard Time AEMO GBB (WA) Report Application Programming Interface 11

12 4.1.2 Common fields A list of common fields used across reports is shown in Table 9 below. Table 9 Common Report Fields Field Name Data Type Description reportid Char(37) A unique identifier for the report. rowid Number(9, 0) The unique number of the row within a report. Row numbers are returned in ascending order. asat Date/Time The date and time that the report was generated. gasday Date The Gas Day of the report. Rows Array For reports in JSON format, contains the rows that make up the report. links Object An object containing links to other reports of the same type, relative to the current report. The field names of the object can take the following values: first the latest report on the first day that reports are available. current the latest report on the last day that reports are available. previous the latest report on the closest prior gas day that has reports available. Note that the value will be null for the earliest available report. next the latest report on the day next later gas day that has reports available. Note that the value will be null for the latest available report. Each link value contains an object containing two fields: gasday contains the gas day on for the report that is linked. location contains the path where the report can be accessed Timing Actual flow reports are generated between 2pm and 6pm for Gas Day D-2. A report may be regenerated at a later date by AEMO where it has become aware of erroneous or missing data. AEMO will send a notice to the GBB (WA) Users and publish a notice on the GBB (WA). AEMO GBB (WA) Report Application Programming Interface 12

13 4.1.4 JSON Format All reports in JSON format contain the same report structure. This is shown in the example below: "reportid":"79e2cd8b-c e-93f9-f8737eb68bdb", "asat":" t06:00: :00", "gasday":" ", "rows": [ ], "links": "first": "gasday": " ", "location": "/api/v1/report/actualflow/79e2cd8b-c e-93f9-f8737eb68bdb", "previous": null, "next": "gasday": " ", "location": "/api/v1/report/actualflow/2e8f57fd a9c4-d2324a5c2aa8", "current": "gasday": " ", "location": "/api/v1/report/actualflow/current" The fields in the JSON report object are described in section 4.1. The format of the data contained in the rows field is report specific and will differ according to the report returned. This common report format will not be described in for individual reports. Only the format of the rows will be described. 4.2 Actual Flows Table 10 Actual Flows Purpose Generated At Updated Monthly Report Provides gas flows for a Gas Day for: Zones, aggregated by receipt and delivery; Gate Stations; and Storage Facilities. Daily, between 2pm and 6pm for the Gas Day two days prior (D-2). Yes. A report may be re-generated at a later date by AEMO where it has become aware of erroneous or missing data. AEMO will send a notice to the GBB (WA) Users and publish a notice on the GBB (WA). Monthly reports are available in CSV format URL A number of URLs can be used to retrieve actual flow data. These are listed below: Table 11 Actual Flow URLs URL Description An actual flow report in JSON format for the specified report id. An actual flow report in CSV format for the specified report id. AEMO GBB (WA) Report Application Programming Interface 13

14 URL day] day].csv Description The current actual flow report in JSON format. The current actual flow report in CSV format. The latest actual flow report in JSON format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest actual flow report in CSV format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest daily reports for all days in the given month in CSV format. The month must be specified in YYYY-MM format JSON Row Format The following fields are available in each row of the report. Table 12 Actual Flow JSON Row Format rowid Number(9, 0) Yes See section facilitycode Char(10) Yes The unique code for the Facility reporting the actual flow. facilityname Char(100) Yes The name of the Facility reporting the actual flow. facilitytype Char(10) Yes Can be one of: pipeline for a Pipeline; or storage for a Storage Facility. gatestationcode Char(20) No The code of the Gate Station at which the flow occurred. Only specified only for a Gate Station flow. gatestationname Char(100) No The name of the Gate Station at which the flow occurred. Only specified only for a Gate Station flow. zonecode Char(2) No The zone code for which actual flows are aggregated. Only specified for actual flow aggregations by zone. zonename Char(30) No The zone name for which actual flows are aggregated. Only specified for actual flow aggregations by zone. receipt Number(6, 1) No The volume of gas in TJ that was received from a Pipeline over the Gas Day. This field can be null for Gate Station rows. delivery Number(6, 1) Yes The volume of gas in TJ that was delivered by a Pipeline over the Gas Day CSV Format The following fields are available for the CSV report. Table 13 Actual Flow CSV Fields rowid Number(9, 0) Yes See section gasday Date Yes See section facilitycode Char(10) Yes The unique code for the Facility reporting the actual flow. facilityname Char(100) Yes The name of the Facility reporting the actual flow. facilitytype Char(10) Yes Can be one of: PIPELINE for a Pipeline; or STORAGE for a Storage Facility. AEMO GBB (WA) Report Application Programming Interface 14

15 gatestationcode Char(20) No The code of the Gate Station at which the flow occurred. Only specified only for a Gate Station flow. gatestationname Char(100) No The name of the Gate Station at which the flow occurred. Only specified only for a Gate Station flow. zonecode Char(2) No The zone code for which actual flows are aggregated. Only specified for actual flow aggregations by zone. zonename Char(30) No The zone name for which actual flows are aggregated. Only specified for actual flow aggregations by zone. receipt Number(6, 1) No The amount of gas in TJ that was received from a Pipeline over the Gas Day. This field can be null for Gate Station rows JSON Example "reportid":"79e2cd8b-c e-93f9-f8737eb68bdb", "asat":" t06:00: :00", "gasday":" ", "rows": [ "rowid":1, "facilitycode":"pipe1", "facilityname":"pipeline 1", "facilitytype":"pipeline", "gatestationcode":null, "gatestationname":null, "zonecode":"aa", "zonename":"zone A", "receipt":1120, "delivery":391.1, "rowid":2, "facilitycode":"pipe1", "facilityname":"pipeline 1", "facilitytype":"pipeline", "gatestationcode":"pipe1-gs2", "gatestationname":"gate Station 2", "zonecode":null, "zonename":null, "receipt":null, "delivery":24.4, "rowid":3, "facilitycode":"stor1", "facilityname":"storage Facility 1", "facilitytype":"storage", "gatestationcode":null, "gatestationname":null, "zonecode":null, "zonename":null, "receipt":0, "delivery":23.7 ], "links": "first": "gasday": " ", "location": "/api/v1/report/actualflow/e6ea2b4d db3-b6c4-c44dc15d4b76", "previous": AEMO GBB (WA) Report Application Programming Interface 15

16 "gasday": " ", "location": "/api/v1/report/actualflow/e6ea2b4d db3-b6c4-c44dc15d4b76", "next": "gasday": " ", "location": "/api/v1/report/actualflow/0e6488a0-f0ba-4e4e-841d-f64c820c9d15", "current": "gasday": " ", "location": "/api/v1/report/actualflow/current" CSV Example rowid,gasday,facilitycode,facilityname,facilitytype,gatestationcode,gatestationname,zonecode,zo nename,receipt,delivery 1, ,PIPE1,Pipeline 1,PIPELINE,,,DM,Dampier,1120, , ,PIPE1,Pipeline 1,PIPELINE,XDBNGP-OP5-01,Caversham,,,,24.4 3, ,STOR1,Storage Facility 1,STORAGE,,,,,0,23.7 AEMO GBB (WA) Report Application Programming Interface 16

17 4.3 Capacity Outlook Table 14 Capacity Outlook Purpose Contains the seven day Capacity Outlook for: Pipelines and their Gate Stations; Production Facilities; and Storage Facilities. Generated At Daily, between 6am and 8am for the upcoming Gas Day (D+1) and the next six days (up to D+7). Updated Yes. Regenerated on receipt of submissions that affect the current Gas Day. Monthly Report Monthly reports are not available URL A number of URLs can be used to retrieve Capacity Outlook data. These are listed below: Table 15 Capacity Outlook URL URL day] day].csv Description A Capacity Outlook report in JSON format for the specified report id. A Capacity Outlook report in CSV format for the specified report id. The current Capacity Outlook report in JSON format. The current Capacity Outlook report in CSV format. The latest Capacity Outlook report in JSON format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest Capacity Outlook report in CSV format for the gas day. The gas day must be specified in YYYY-MM-DD format JSON Row Format The following fields are available in each row of the JSON report. Table 16 Capacity Outlook JSON Row Format rowid Number(9, 0) Yes See section facilitycode Char(10) Yes The code of the Facility to which the capacities relate. facilityname Char(100) Yes The name of the Facility to which the capacities relate. connectionpointcode Char(20) No The code of the connection point to which the capacities relate. Only provided for Gate Station capacities. connectionpointname Char(100) No The name of the connection point to which the capacities relate. Only provided for Gate Station capacities. capacitytype Char(30) Yes Can be one of: Pipeline Capacity ; Gate Station Capacity ; Production Capacity ; Storage Receipt Capacity ; or Storage Delivery Capacity. AEMO GBB (WA) Report Application Programming Interface 17

18 direction Char(3) No The direction of the capacity. Only applicable for Storage Facilities. Can be one of: IN for receipt capacity OUT for delivery capacity capacity JSON Object Yes A JSON object containing seven fields, named d0 through to d6. Each field is the capacity for a Gas Day, with the number in the field name representing the number of Gas Days offset from the report Gas Day. For example d0 is the report Gas Day and d6 is the Gas Day six days after the report Gas Day CSV Format The following fields are available in each row of the CSV report. Table 17 Capacity Outlook CSV Format rowid Number(9, 0) Yes See section gasday Date Yes See section facilitycode Char(10) Yes The code of the Facility to which the capacities relate. facilityname Char(100) Yes The name of the Facility to which the capacities relate. connectionpointcode Char(20) No The code of the connection point to which the capacities relate. Only provided for Gate Station capacities. connectionpointname Char(100) No The name of the connection point to which the capacities relate. Only provided for Gate Station capacities. capacitytype Char(30) Yes Can be one of: Pipeline Capacity ; Gate Station Capacity ; Production Capacity ; Storage Receipt Capacity ; or Storage Delivery Capacity. direction Char(3) No The direction of the capacity. Only applicable for Storage Facilities. Can be one of: IN for receipt capacity; or OUT for delivery capacity. capacityd0 Number(6, 1) Yes The capacity in TJ for the Gas Day of the report (i.e. in the gasday field). capacityd1 Number(6, 1) Yes The capacity in TJ for 1 day after the date in the gasday field. capacityd2 Number(6, 1) Yes The capacity in TJ for 2 days after the date in the gasday field. capacityd3 Number(6, 1) Yes The capacity in TJ for 3 days after the date in the gasday field. capacityd4 Number(6, 1) Yes The capacity in TJ for 4 days after the date in the gasday field. capacityd5 Number(6, 1) Yes The capacity in TJ for 5 days after the date in the gasday field. capacityd6 Number(6, 1) Yes The capacity in TJ for 6 days after the date in the gasday field. AEMO GBB (WA) Report Application Programming Interface 18

19 4.3.4 JSON Example "reportid":"0d3ddd4c-d241-4df fdb6cdaf13", "asat":" t12:30: :00", "gasday":" ", "rows": [ "rowid":1, "facilitycode":"pipe1", "facilityname":"pipeline 1", "connectionpointcode":"pipe1-gs2", "connectionpointname":"gate Station 2", "capacitytype":"gate Station Capacity", "direction":null, "capacity":"d0":17.8,"d1":23.5,"d2":23.5,"d3":23.5,"d4":23.5,"d5":23.5,"d6":23.5, "rowid":2, "facilitycode":"pipe1", "facilityname":"pipeline 1", "connectionpointcode":null, "connectionpointname":null, "capacitytype":"pipeline Capacity", "direction":null, "capacity":"d0":685,"d1":685,"d2":685,"d3":685,"d4":685,"d5":685,"d6":685, "rowid":3, "facilitycode":"prod2", "facilityname":"production Facility 2", "connectionpointcode":null, "connectionpointname":null, "capacitytype":"production Capacity", "direction":null, "capacity":"d0":208,"d1":208,"d2":208,"d3":208,"d4":208,"d5":208,"d6":208, "rowid":4, "facilitycode":"stor1", "facilityname":"storage Facility 1", "connectionpointcode":null, "connectionpointname":null, "capacitytype":"storage Receipt Capacity", "direction":"in", "capacity":"d0":12,"d1":12,"d2":12,"d3":12,"d4":12,"d5":12,"d6":12, "rowid":5, "facilitycode":"stor1", "facilityname":"storage Facility 1", "connectionpointcode":null, "connectionpointname":null, "capacitytype":"storage Delivery Capacity", "direction":"out", "capacity":"d0":15,"d1":15,"d2":15,"d3":15,"d4":15,"d5":15,"d6":15 ], "links": "first": "gasday": " ", "location": "/api/v1/report/capacityoutlook/b626aec adb7-b4e56cb697b6", "previous": "gasday": " ", "location": "/api/v1/report/capacityoutlook/c eb ae5-71e106f0aa65", "next": "gasday": " ", "location": "/api/v1/report/capacityoutlook/8076f893-9c40-47dc-ad5e-a671dc22e818", AEMO GBB (WA) Report Application Programming Interface 19

20 "current": "gasday": " ", "location": "/api/v1/report/capacityoutlook/current" CSV Example rowid,gasday,facilitycode,facilityname,connectionpointcode,connectionpointname,capacitytype,dir ection,capacityd0,capacityd1,capacityd2,capacityd3,capacityd4,capacityd5,capacityd6 1, ,PIPE1,Pipeline 1,PIPE1-GS2,Gate Station 2,Gate Station Capacity,,17.8,23.5,23.5,23.5,23.5,23.5,23.5 2, ,PIPE1,Pipeline 1,,,Pipeline Capacity,,685,685,685,685,685,685,685 3, ,PROD2,Production Facility 2,,,Production Capacity,,208,208,208,208,208,208,208 4, ,STOR1,Storage Facility 1,,,Storage Receipt Capacity,IN,12,12,12,12,12,12,12 5, ,STOR1,Storage Facility 1,,,Storage Delivery Capacity,OUT,15,15,15,15,15,15,15 AEMO GBB (WA) Report Application Programming Interface 20

21 4.4 End User Consumption Table 18 End User Consumption Purpose Generated At Updated Monthly Reports Contains aggregate daily consumption by zone of Large User Facilities, users in Distribution Systems and other users. Daily, between 2pm and 6pm for the Gas Day two days prior (D-2). Yes. A report may be re-generated at a later date by AEMO where it has become aware of erroneous or missing data. AEMO will send a notice to the GBB (WA) Users and publish a notice on the GBB (WA). Monthly reports are available in CSV format. The end user consumption report provides daily aggregated consumption by large users, Distribution Systems and other consumption aggregated by zone URL A number of URLs can be used to retrieve end user consumption data. These are listed below: Table 19 End User Consumption URL URL id] id].csv urrent urrent.csv gas day] gas day].csv month].csv Description An end user consumption report in JSON format for the specified report id. An end user consumption report in CSV format for the specified report id. The current end user consumption report in JSON format. The current end user consumption report in CSV format. The latest end user consumption report in JSON format for the gas day. The gas day must be specified in YYYY-MM- DD format. The latest end user consumption report in CSV format for the gas day. The gas day must be specified in YYYY-MM- DD format. The latest daily reports for all days in the given month in CSV format. The month must be specified in YYYY-MM format JSON Row Format The following fields are available in each row of the JSON report. Table 20 End User Consumption JSON Row Format rowid Number(9, 0) Yes See section zonecode Char(2) Yes The code of the zone in which the consumption occurred. zonename Char(30) Yes The name of the zone in which the consumption occurred. largeuser Number(6, 1) Yes The amount of gas (in TJ) consumed by Large User Facilities in the zone for the Gas Day. distribution Number(6, 1) Yes The amount of gas consumed through Distribution Systems (excluding Large User Facilities connected via Distribution Systems) in the zone for the Gas Day. other Number(6, 1) Yes The amount of gas (in TJ) consumed by users other than Large User Facilities or Distribution Systems in the zone for the Gas Day. AEMO GBB (WA) Report Application Programming Interface 21

22 total Number(6, 1) Yes The total amount of gas (in TJ) consumed in the zone for the Gas Day CSV Format The following fields are available in each row of the CSV report Table 21 End User Consumption CSV Format rowid Integer Yes See section gasday Date Yes See section zonecode Char(2) Yes The code of the zone in which the consumption occurred. zonename Char(30) Yes The name of the zone in which the consumption occurred. largeuser Number(6, 1) Yes The amount of gas (in TJ) consumed by Large User Facilities in the zone for the Gas Day. distribution Number(6, 1) Yes The amount of gas consumed through Distribution Systems (excluding Large User Facilities connected via Distribution Systems) in the zone for the Gas Day. other Number(6, 1) Yes The amount of gas (in TJ) consumed by users other than Large User Facilities or Distribution Systems in the zone for the Gas Day. total Number(6, 1) Yes The total amount of gas (in TJ) consumed in the zone for the Gas Day JSON Example "reportid":"6601e81e-438f-4e6f-a1e1-a09db4809f7c", "asat":" t14:00: :00", "gasday":" ", "rows": [ "rowid":1, "zonecode":"aa", "zonename":"zone A", "largeuser":107.4, "distribution":0, "other":151.5, "total":258.9, "rowid":2, "zonecode":"bb", "zonename":"zone B", "largeuser":48.6, "distribution":0, "other":17.2, "total":65.8 ], "links": "first": "gasday": " ", "location": "/api/v1/report/enduserconsumption/1153fd dd1-abad-231ef754ead5", "previous": null, "next": "gasday": " ", "location": "/api/v1/report/enduserconsumption/72419e2b b-a3ea-c fe9", AEMO GBB (WA) Report Application Programming Interface 22

23 "current": "gasday": " ", "location": "/api/v1/report/enduserconsumption/current" CSV Example rowid,gasday,zonecode,zonename,largeuser,distribution,other,total 1, ,AA,Zone A,107.4,0,151.5, , ,BB,Zone B,48.6,0,17.2,65.8 AEMO GBB (WA) Report Application Programming Interface 23

24 4.5 Nominations and Forecasts Table 22 Nominations and Forecasts Purpose Provides nominated and forecast gas flows, aggregated by receipt and delivery for all zones. Generated At Daily, between 6am and 8am for the upcoming Gas Day (D+1) and the next six days (up to D+7). Updated Yes. Regenerated on receipt of submissions that affect the current Gas Day. Monthly Report Monthly reports are not available URL A number of URLs can be used to retrieve nominated and forecast flow data. These are listed below. Table 23 Nominations and Forecasts URL URL day] day].csv Description A nominations and forecasts report in JSON format for the specified report id. A nominations and forecasts report in CSV format for the specified report id. The current nominations and forecasts report in JSON format. The current nominations and forecasts report in CSV format. The latest nominations and forecasts report in JSON format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest nominations and forecasts report in CSV format for the gas day. The gas day must be specified in YYYY-MM-DD format JSON Row Format The following fields are available in each row of the JSON report. Table 24 Nominations and Forecasts JSON Row Format rowid Number(9, 0) Yes See section facilitycode Char(10) No The code of the Facility. Only populated when the nominations and forecasts relate to a Storage Facility. facilityname Char(100) No The name of the Facility. Only populated when the nominations and forecasts relate to a Storage Facility. zonecode Char(2) No The code of the zone. Only populated when the nominations and forecasts relate to a zone. zonename Char(30) No The name of the zone. Only populated when the nominations and forecasts relate to a zone. AEMO GBB (WA) Report Application Programming Interface 24

25 forecast JSON Object Yes A JSON object containing seven fields, named d0 through to d6. Each field contains the forecasts for a Gas Day, with the number in the field name representing the number of Gas Days offset from the report Gas Day. For example d0 is the report Gas Day and d6 is the Gas Day six days after the report Gas Day. During the transitional period, days d0 to d2 will be populated, and d3 to d6 may be null. After the transitional period, all days will be populated. The format of the receipt and delivery forecasts for each day is described in the following table. The following table describes the receipt and delivery forecasts for a Gas Day. Table 25 Nominations and Forecasts JSON Row Format receipt Number(6, 1) Yes The forecast amount of gas in TJ received on the Gas Day within the zone, or at the Storage Facility. delivery Number(6, 1) Yes The forecast amount of gas in TJ delivered on the Gas Day within the zone, or at the Storage Facility CSV Format The following fields are available in each row of the CSV report. Table 26 Nominations and Forecasts CSV Format rowid Integer Yes See section gasday Date Yes See section facilitycode Char(10) No The code of the Facility. Only populated when the nominations and forecasts relate to a Storage Facility. facilityname Char(100) No The name of the Facility. Only populated when the nominations and forecasts relate to a Storage Facility. zonecode Char(2) No The code of the zone. Only populated when the nominations and forecasts relate to a zone. zonename Char(30) No The name of the zone. Only populated when the nominations and forecasts relate to a zone. receiptd0 Number(6, 1) Yes The nominated recepts within the zone or at the Storage Facility for the Gas Day of the report. deliveryd0 Number(6, 1) Yes The nominated deliveries within the zone or at the Storage Facility for the Gas Day or the report. receiptd1 Number(6, 1) Yes The forecast receipts within the zone or at the Storage Facility for 1 day after the report Gas Day. deliveryd1 Number(6, 1) Yes The forecast deliveries within the zone or at the Storage Facility for 1 day after the report Gas Day. receiptd2 Number(6, 1) Yes The forecast receipts within the zone or at the Storage Facility for 2 days after the report Gas Day. deliveryd2 Number(6, 1) Yes The forecast deliveries within the zone or at the Storage Facility for 2 days after the report Gas Day. receiptd3 Number(6, 1) No The forecast receipts within the zone or at the Storage Facility for 3 days after the report Gas Day. During the transition period, there may be no value supplied for this field. AEMO GBB (WA) Report Application Programming Interface 25

26 deliveryd3 Number(6, 1) No The forecast deliveries within the zone or at the Storage Facility for 3 days after the report Gas Day. During the transition period, there may be no value supplied for this field. receiptd4 Number(6, 1) No The forecast receipts within the zone or at the Storage Facility for 4 days after the report Gas Day. During the transition period, there may be no value supplied for this field. deliveryd4 Number(6, 1) No The forecast deliveries within the zone or at the Storage Facility for 4 days after the report Gas Day. During the transition period, there may be no value supplied for this field. receiptd5 Number(6, 1) No The forecast receipts within the zone or at the Storage Facility for 5 days after the report Gas Day. During the transition period, there may be no value supplied for this field. deliveryd5 Number(6, 1) No The forecast deliveries within the zone or at the Storage Facility for 5 days after the report Gas Day. During the transition period, there may be no value supplied for this field. receiptd6 Number(6, 1) No The forecast receipts within the zone or at the Storage Facility for 6 days after the report Gas Day. During the transition period, there may be no value supplied for this field. deliveryd6 Number(6, 1) No The forecast deliveries within the zone or at the Storage Facility for 6 days after the report Gas Day. During the transition period, there may be no value supplied for this field. AEMO GBB (WA) Report Application Programming Interface 26

27 4.5.4 JSON Example "reportid":"9fe521a df2-ae e9367a6f", "asat":" t06:00: :00", "gasday":" ", "rows": [ "rowid":1, "facilitycode":null, "facilityname":null, "zonecode":"aa", "zonename":"zone A", "forecast": "d0":"receipt":898,"delivery":493, "d1":"receipt":925,"delivery":501, "d2":"receipt":870,"delivery":475, "d3":null, "d4":null, "d5":null, "d6":null, "rowid":2, "facilitycode":"stor1", "facilityname":"storage Facility 1", "zonecode":null, "zonename":null, "forecast": "d0":"receipt":98,"delivery":0, "d1":"receipt":83,"delivery":0, "d2":"receipt":112,"delivery":0, "d3":null, "d4":null, "d5":null, "d6":null ], "links": "first": "gasday": " ", "location": "/api/v1/report/forecastflow/07ac3c7e-e3b d f714e1b", "previous": "gasday": " ", "location": "/api/v1/report/forecastflow/4b6e34ef-ba3b df ec89b77", "next": "gasday": " ", "location": "/api/v1/report/forecastflow/d2e3b03a a848-78d70d9ed53f", "current": "gasday": " ", "location": "/api/v1/report/forecastflow/current" AEMO GBB (WA) Report Application Programming Interface 27

28 4.5.5 CSV Example rowid,gasday,facilitycode,facilityname,zonecode,zonename,receiptd0,deliveryd0,receiptd1,deliver yd1,receiptd2,deliveryd2,receiptd3,deliveryd3,receiptd4,deliveryd4,receiptd5,deliveryd5,receipt D6,deliveryD6 1, ,,,AA,Zone A,898,493,925,501,870,475,,,,,,,, 2, ,STOR1,Storage Facility 1,,,98,0,83,0,112,0,,,,,,,, 4.6 Gas Specification Table 27 Gas Specification Purpose Generated At Updated Monthly Reports URL Provides gas quality information for Pipelines and Production Facilities that are affected by a Pipeline Impact Agreement (PIA). Daily, between 2pm and 6pm for the Gas Day eight days prior (D-8). Yes. A report may be re-generated at a later date by AEMO where it has become aware of erroneous or missing data. AEMO will send a notice to the GBB (WA) Users and publish a notice on the GBB (WA). Monthly reports are not available. A number of URLs can be used to retrieve gas specification data. These are listed below. Table 28 Gas Specification URL URL v day] day].csv Description A gas specification report in JSON format for the specified report id. A gas specification report in CSV format for the specified report id. The current gas specification report in JSON format. The current gas specification report in CSV format. The latest gas specification report in JSON format for the gas day. The gas day must be specified in YYYY- MM-DD format. The latest gas specification report in CSV format for the gas day. The gas day must be specified in YYYY- MM-DD format JSON Row Format The following fields are available in each row of the JSON report. Table 29 Gas Specification JSON Row Format rowid Number(9, 0) Yes See section facilitycode Char(10) Yes The code of the Facility supplying the gas specification information. facilityname Char(100) Yes The name of the Facility supplying the gas specification information. facilitytype Char(10) Yes The type of Facility supplying the gas specification. Can be one of: Pipeline for a Pipeline; or production for a Production Facility. AEMO GBB (WA) Report Application Programming Interface 28

29 connectionpointcode Char(20) No The code of the connection point immediately downstream of where the gas specification was measured. This field is only populated for Pipelines. connectionpointname Char(100) No The name of the connection point immediately downstream of where the gas specification was measured. This field is only populated for Pipelines. hhv Number(3, 1) Yes The Higher Heating Value (HHV) in MH/m 3 measurement for the Gas Day. quantity Number(10, 1) No The quantity of gas produced by the Production Facility in m 3. This field is only populated for Production Facilities CSV Format The following fields are available in each row of the CSV report. Table 30 Gas Specification CSV Format rowid Number(9, 0) Yes See section gasday Date Yes See section facilitycode Char(10) Yes The code of the Facility supplying the gas specification information. facilityname Char(100) Yes The name of the Facility supplying the gas specification information. facilitytype Char(10) Yes The type of Facility supplying the gas specification. Can be one of: PIPELINE for a Pipeline; or PRODUCTION for a Production Facility. connectionpointcode Char(20) No The code of the connection point immediately downstream of where the gas specification was measured. This field is only populated for Pipelines. connectionpointname Char(100) No The name of the connection point immediately downstream of where the gas specification was measured. This field is only populated for Pipelines. hhv Number(3, 1) Yes The Higher Heating Value (HHV) in MH/m 3 measurement for the Gas Day. quantity Number(10, 1) No The quantity of gas produced by the Production Facility in m 3. This field is only populated for Production Facilities JSON Example "reportid":"87511a1b-ecfd-403f-851f-4cd72c2564ff", "asat":" t14:00: :00", "gasday":" ", "rows": [ "rowid":1, "gasday":" ", "facilitycode":"pipe1", "facilityname":"pipeline 1", "facilitytype":"pipeline", "connectionpointcode":"pipe1-gs3", "connectionpointname":"gate Station 3", "hhv":42.7, "quantity":null, AEMO GBB (WA) Report Application Programming Interface 29

30 "rowid":2, "gasday":" ", "facilitycode":"prod3", "facilityname":"production Facility 3", "facilitytype":"production", "connectionpointcode":null, "connectionpointname":null, "hhv":43.8, "quantity":12044 ], "links": "first": "gasday": " ", "location": "/api/v1/report/gasspecification/60e947c2-c adcc-b44fc7f1146a", "previous": "gasday": " ", "location": "/api/v1/report/gasspecification/60e947c2-c adcc-b44fc7f1146a", "next": "gasday": " ", "location": "/api/v1/report/gasspecification/90ba9e6b-404a-43a0-9bed d07f74", "current": "gasday": " ", "location": "/api/v1/report/gasspecification/current" AEMO GBB (WA) Report Application Programming Interface 30

31 4.6.5 CSV Example rowid,gasday,facilitycode,facilityname,facilitytype,connectionpointcode,connectionpointname,hhv,quantity 1, ,PIPE1,Pipeline 1,PIPELINE,XDBNGP-O81-01,Nangetty Road,42.7, 2, ,PROD3,Production Facility 3,PRODUCTION,,,43.8, Large User Consumption Table 31 Large User Consumption Purpose Generated At Updated Monthly Report URL Provides consumption for every Large User Facility for a Gas Day. Daily, between 2pm and 6pm for the Gas Day seven days prior (D-7). Yes. A report may be re-generated at a later date by AEMO where it has become aware of erroneous or missing data. AEMO will send a notice to the GBB (WA) Users and publish a notice on the GBB (WA). Monthly reports are available in CSV format. A number of URLs can be used to retrieve large user consumption data. These are listed below. Table 32 Large User Consumption URL URL ] ].csv rent rent.csv s day] s day].csv nth].csv Description A large user consumption report in JSON format for the specified report id. A large user consumption report in CSV format for the specified report id. The current large user consumption report in JSON format. The current large user consumption report in CSV format. The latest large user consumption report in JSON format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest large user consumption report in CSV format for the gas day. The gas day must be specified in YYYY-MM-DD format. The latest daily reports for all days in the given month in CSV format. The month must be specified in YYYY- MM format JSON Row Format The following fields are available in each row of the JSON report. Table 33 Large User Consumption JSON Row Format rowid Number(9, 0) Yes See section facilitycode Char(10) Yes The code of the Large User Facility for which the consumption relates. facilityname Char(100) Yes The name of the Large User Facility for which the consumption relates. AEMO GBB (WA) Report Application Programming Interface 31