Submission Open API Spec
openapi: 3.0.1
info:
title: Submission
description: "\n## Introduction\nThe submission API allows participants to submit data to the Gas Bulletin Board (BB). \nData submission from BB reporting entities to the BB are divided into two key areas-\n- Data transfer formats which includes the form, validation rules, and timing of submissions.\n- Data submission methods to the BB, and how the success and failure of those submissions is communicated back to the submitter.\n\nFor details on how to get access and business rules for this API:\n\n<a href=\"/api-docs\"><img src=\"./files/ViewAPIDocsButton.png\" alt=\"View API Docs\" /></a>"
version: v1
servers:
- url: https://api-dev.aemo.local/ws/gbb/submission/v1
paths:
/dailyProductionAndFlow:
post:
summary: Add new daily Production And Flow
description: 'Provide on each gas day D, the BB facility operator’s daily gas flow data for receipts and deliveries and transitional compression facility operator’s daily gas compression'
operationId: postDailyProductionAndFlow
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- GasDate
- FacilityId
- ConnectionPointId
- FlowDirection
- ActualQuantity
- Quality
type: object
properties:
GasDate:
$ref: '#/components/schemas/GasDate'
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
ConnectionPointId:
type: integer
description: A unique AEMO defined connection point identifier. Conditional- This information is mandatory for BB pipelines. Otherwise leave this field blank.
example: 1301002
FlowDirection:
maxLength: 8
enum:
- RECEIPT
- DELIVERY
- N/A
- COMPRESSED
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. N/A — Zero gas flows have been measured for the gas date or data is unavailable. COMPRESSED – The action performed by a transitional compression facility'
ActualQuantity:
$ref: '#/components/schemas/ActualQuantity'
Quality:
$ref: '#/components/schemas/Quality'
example:
GasDate: '2018-09-23'
FacilityId: 520001
ConnectionPointId: 1301002
FlowDirection: RECEIPT
ActualQuantity: 32.232
Quality: OK
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/dailyStorage:
post:
summary: Add new daily storage
description: 'Provide on each gas day D, the actual quantity of natural gas held in each storage facility at the end of the gas day D.'
operationId: postDailyStorage
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- GasDate
- FacilityId
- ActualQuantity
type: object
properties:
GasDate:
$ref: '#/components/schemas/GasDate'
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
ActualQuantity:
$ref: '#/components/schemas/ActualQuantity'
example:
GasDate: '2018-09-23'
FacilityId: 520001
ActualQuantity: 32.232
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/gateStationNameplateRating:
post:
summary: Add new Gate Station Nameplate Rating
description: "Provide nameplate ratings -\n- For each gate station connection point owned, controlled, or operated by the BB pipeline operator and connected to each of its BB pipelines.\n- For each gate station connection point connected to each of its pipelines which is not owned, controlled, or operated by the BB pipeline operator, where the connection point nameplate rating has been provided to the BB pipeline operator by the facility who owns, controls, or operates the gate station."
operationId: postGateStationNameplateRating
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- ConnectionPointId
- CapacityQuantity
- EffectiveDate
type: object
properties:
ConnectionPointId:
$ref: '#/components/schemas/ConnectionPointId'
CapacityQuantity:
$ref: '#/components/schemas/CapacityQuantity'
EffectiveDate:
$ref: '#/components/schemas/EffectiveDate'
Description:
$ref: '#/components/schemas/Description'
example:
ConnectionPointId: 1301002
CapacityQuantity: 201.65
EffectiveDate: '2018-08-06'
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/connectionPointNameplateRating:
post:
summary: Add new Connection Point Nameplate Rating
description: "Provide nameplate ratings-\n - For each connection point owned, controlled, or operated by the BB pipeline operator and connected to each of its BB pipelines.\n - For each connection point owned, controlled, or operated by the Part 24 facility operator and connected to each of its transitional compression facilities.\n - For each connection point connected to each of its pipelines which is not owned, controlled, or operated by the BB pipeline operator, where the connection point nameplate rating has been provided to the BB pipeline operator by the facility who owns, controls, or operates the connection point."
operationId: postConnectionPointNameplateRating
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- ConnectionPointId
- CapacityQuantity
- EffectiveDate
type: object
properties:
ConnectionPointId:
$ref: '#/components/schemas/ConnectionPointId'
CapacityQuantity:
$ref: '#/components/schemas/CapacityQuantity'
EffectiveDate:
$ref: '#/components/schemas/EffectiveDate'
Description:
$ref: '#/components/schemas/Description'
example:
ConnectionPointId: 1301002
CapacityQuantity: 201.65
EffectiveDate: '2018-08-06'
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/linepackCapacityAdequacy:
post:
summary: Add new linepack Capacity Adequacy
description: 'Provide a Linepack Capacity Adequacy (LCA) report that indicates (flags) the status for each pipeline and transitional compression facility for a three-day outlook period. The flags are traffic light colours (Green, Amber, Red) indicates the LCA status for each pipeline.'
operationId: postLinepackCapacityAdequacy
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- GasDate
- CapacityQuantity
- Flag
type: object
properties:
GasDate:
$ref: '#/components/schemas/GasDate'
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
Flag:
$ref: '#/components/schemas/Flag'
Description:
$ref: '#/components/schemas/Description'
example:
GasDate: '2018-09-23'
FacilityId: 520001
Flag: GREEN
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/mediumTermCapacityOutlook:
post:
summary: Add new medium Term Capacity Outlook
description: 'Provide details of any activity expected to affect the daily capacity of a BB pipeline, BB production, or BB storage facility in the next 36 months.'
operationId: postMediumTermCapacityOutlook
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- FacilityId
type: object
properties:
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
FromGasDate:
type: string
description: Date of gas day. Any time component supplied is ignored. The gas day is applicable under the pipeline contract or market rules. This field can be left blank if all other fields (excluding Facility Id) are also left blank. This clears all existing future dated Medium Term Capacity Outlook submissions.
example: '2018-03-10'
ToGasDate:
type: string
description: Date of gas day. Any time component supplied is ignored. The gas day is applicable under the pipeline contract or market rules. This field can be left blank if all other fields (excluding Facility Id) are also left blank. This clears all existing future dated Medium Term Capacity Outlook submissions.
example: '2018-03-20'
CapacityType:
$ref: '#/components/schemas/CapacityType'
OutlookQuantity:
$ref: '#/components/schemas/OutlookQuantity'
FlowDirection:
maxLength: 8
enum:
- RECEIPT
- DELIVERY
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. This field can be left blank if all other fields (excluding Facility Id) are also left blank. This clears all existing future dated Medium Term Capacity Outlook submissions.'
CapacityDescription:
$ref: '#/components/schemas/CapacityDescription'
ReceiptLocation:
$ref: '#/components/schemas/ReceiptLocation'
DeliveryLocation:
$ref: '#/components/schemas/DeliveryLocation'
Description:
maxLength: 255
type: string
description: 'Comments about the quantity or change in Outlook Quantity relating to the Facility Id, and the times, dates, or duration which those quantities or changes in quantities. This field can be left blank if all other f'
example: This is some comments
example:
FacilityId: 520001
FromGasDate: '2018-03-10'
ToGasDate: '2018-03-20'
CapacityType: STORAGE
OutlookQuantity: 200.531
FlowDirection: RECEIPT
CapacityDescription: This transmission capacity is the amount of gas that the Culcairn delivery point is able to withdraw from this pipeline facility. This capacity is dependent on the forecast DTS demand and the availability of key assets on this pipeline facility
ReceiptLocation: 1200001
DeliveryLocation: 1300056
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/nameplateRating:
post:
summary: Add new nameplate Rating
description: Provide the nameplate rating of each facility or information about any planned permanent capacity reduction or expansion due to modification of the facility.
operationId: postNameplateRating
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- FacilityId
- CapacityType
- CapacityQuantity
- EffectiveDate
- Description
type: object
properties:
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
CapacityType:
$ref: '#/components/schemas/CapacityType'
CapacityQuantity:
$ref: '#/components/schemas/CapacityQuantity'
FlowDirection:
maxLength: 10
enum:
- RECEIPT
- DELIVERY
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. This field is mandatory for BB storage facilities with a MDQ Capacity Type value. Otherwise leave this field blank.'
CapacityDescription:
maxLength: 800
type: string
description: 'Free text to describe the meaning of the capacity number provided, including relevant assumptions made in the calculation of the capacity number and any other relevant information. If applicable, transitional compression facilities must also provide a Capacity Description of other maximum quantities under other standard operating conditions including a description of those conditions including expected inlet and outlet pressures. This information is mandatory for BB pipelines and transitional compression facilities. Otherwise leave this field blank.'
example: This is some comments
ReceiptLocation:
$ref: '#/components/schemas/ReceiptLocation'
DeliveryLocation:
$ref: '#/components/schemas/DeliveryLocation'
EffectiveDate:
$ref: '#/components/schemas/EffectiveDate'
Description:
maxLength: 255
type: string
description: 'Free text facility use is restricted to a description for reasons or comments directly related to the quantity or the change in quantity provided in relation to a BB facility (such as daily production data, nameplate rating, LCA flag, etc.), and the times, dates, or duration for which those quantities or changes in quantities are expected to apply.'
example: This is some comments
example:
FacilityId: 520001
CapacityType: STORAGE
CapacityQuantity: 201.65
FlowDirection: RECEIPT
CapacityDescription: This is some comments
ReceiptLocation: 1200001
DeliveryLocation: 1300056
EffectiveDate: '2018-08-06'
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/nominationsAndForecasts:
post:
summary: Provide nominations and forecasts
description: "For BB pipelines forming part of a Declared Transmission System, provide on each gas day the aggregated scheduled injections and aggregated scheduled withdrawals at each controllable system point for gas day D to D+2. \nFor all other BB facility operators, provide on each gas day D the aggregated nominated and forecast injections and aggregated nominated and forecast withdrawals for gas day D to D+6."
operationId: postNominationsAndForecasts
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- GasDate
- FacilityId
- FlowDirection
- NominationQuantity
type: object
properties:
GasDate:
$ref: '#/components/schemas/GasDate'
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
ConnectionPointId:
type: integer
description: A unique AEMO defined connection point identifier. Conditional- This information is mandatory for BB pipelines. Otherwise leave this field blank.
example: 1301002
FlowDirection:
maxLength: 8
enum:
- RECEIPT
- DELIVERY
- N/A
- COMPRESSED
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. N/A — Zero gas flows have been measured for the gas date or data is unavailable. COMPRESSED – The action performed by a transitional compression facility'
NominationQuantity:
$ref: '#/components/schemas/NominationQuantity'
example:
GasDate: '2018-09-23'
FacilityId: 520001
ConnectionPointId: 1301002
FlowDirection: RECEIPT
NominationQuantity: 32.561
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/nominationsAndForecastsNonAggregate:
get:
summary: Get Nominations and forecasts
description: Get Nominations and forecasts
operationId: getNominationsAndForecastsNonAggregate
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful Resonse with NominationsAndForecastsList
content:
application/json:
schema:
example:
transactionId: 1c0e5ce1-2511-4807-883f-ca05357260ff
data:
NominationsAndForecastsList: [ ]
errors: [ ]
warnings: [ ]
example:
transactionId: 1c0e5ce1-2511-4807-883f-ca05357260ff
data:
NominationsAndForecastsList: [ ]
errors: [ ]
warnings: [ ]
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/shortTermCapacityOutlook:
post:
summary: Add new short Term Capacity Outlook
description: 'Provide on each gas day D, the BB facility operator’s good faith estimate of the daily capacity of the BB Facility for gas days D+1 to D+7.'
operationId: postShortTermCapacityOutlook
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- GasDate
- FacilityId
- CapacityType
- OutlookQuantity
type: object
properties:
GasDate:
$ref: '#/components/schemas/GasDate'
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
CapacityType:
$ref: '#/components/schemas/CapacityType'
OutlookQuantity:
$ref: '#/components/schemas/OutlookQuantity'
FlowDirection:
maxLength: 10
enum:
- RECEIPT
- DELIVERY
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. This field is mandatory for BB storage facilities with a MDQ Capacity Type value. Otherwise leave this field blank.'
CapacityDescription:
maxLength: 800
type: string
description: 'Free text to describe the meaning of the capacity number provided, including relevant assumptions made in the calculation of the capacity number and any other relevant information. If applicable, transitional compression facilities must also provide a Capacity Description of other maximum quantities under other standard operating conditions including a description of those conditions including expected inlet and outlet pressures. This information is mandatory for BB pipelines and transitional compression facilities. Otherwise leave this field blank.'
example: This is some comments
ReceiptLocation:
$ref: '#/components/schemas/ReceiptLocation'
DeliveryLocation:
$ref: '#/components/schemas/DeliveryLocation'
Description:
maxLength: 255
description: 'Comments about the quantity or change in Outlook Quantity relating to the Facility Id, and the times, dates, or duration which those quantities or changes in quantities. This field can be left blank if all other f'
example: This is some comments
example:
GasDate: '2018-09-23'
FacilityId: 520001
CapacityType: STORAGE
OutlookQuantity: 200.531
FlowDirection: RECEIPT
CapacityDescription: This is some comments
ReceiptLocation: 1200001
DeliveryLocation: 1300056
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/uncontractedCapacityOutlook:
post:
summary: Add new uncontracted Capacity Outlook
description: "Provides information on -\n- Uncontracted primary pipeline capacity on BB pipelines for the next 36 months. Note- This does not include BB pipelines in the Declared Transmission System.\n- Uncontracted storage capacity on BB storage facilities for the next 36 months.\n- Uncontracted primary compression capacity on transitional compression facilities for the next 36 months."
operationId: postUncontractedCapacityOutlook
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- FacilityId
- OutlookMonth
- OutlookYear
- CapacityType
- OutlookQuantity
type: object
properties:
FacilityId:
type: integer
description: A unique AEMO defined Facility identifier.
example: 520001
OutlookMonth:
$ref: '#/components/schemas/OutlookMonth'
OutlookYear:
$ref: '#/components/schemas/OutlookYear'
CapacityType:
$ref: '#/components/schemas/CapacityType'
OutlookQuantity:
$ref: '#/components/schemas/OutlookQuantity'
FlowDirection:
maxLength: 10
enum:
- RECEIPT
- DELIVERY
type: string
description: 'Values can be either- RECEIPT — A flow of gas into the BB facility, or DELIVERY — A flow of gas out of the BB facility. This field is mandatory for BB storage facilities with a MDQ Capacity Type value. Otherwise leave this field blank.'
CapacityDescription:
maxLength: 800
type: string
description: 'Free text to describe the meaning of the capacity number provided, including relevant assumptions made in the calculation of the capacity number and any other relevant information. If applicable, transitional compression facilities must also provide a Capacity Description of other maximum quantities under other standard operating conditions including a description of those conditions including expected inlet and outlet pressures. This information is mandatory for BB pipelines and transitional compression facilities. Otherwise leave this field blank.'
example: This is some comments
ReceiptLocation:
$ref: '#/components/schemas/ReceiptLocation'
DeliveryLocation:
$ref: '#/components/schemas/DeliveryLocation'
Description:
maxLength: 255
description: 'Comments about the quantity or change in Outlook Quantity relating to the Facility Id, and the times, dates, or duration which those quantities or changes in quantities. This field can be left blank if all other f'
example: This is some comments
example:
FacilityId: 520001
OutlookMonth: 4
OutlookYear: 2018
CapacityType: STORAGE
OutlookQuantity: 200.531
FlowDirection: RECEIPT
CapacityDescription: This is some comments
ReceiptLocation: 1200001
DeliveryLocation: 1300056
Description: This is some comments
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/BBCapacityTransaction:
post:
summary: Submit capacity transaction declarations through to the Bulletin Board
description: 'Provides information on BB Capacity Transactions, excluding those concluded through the gas trading exchange.'
operationId: postBBCapacityTransaction
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- TradeDate
- FromGasDate
- ToGasDate
- BuyerName
- SellerName
- StandardOTSA
- BBTransportationServiceType
- Priority
- Quantity
- MHQ
- Price
type: object
properties:
TradeId:
$ref: '#/components/schemas/TradeId'
TradeDate:
$ref: '#/components/schemas/TradeDate'
FromGasDate:
$ref: '#/components/schemas/FromGasDate'
ToGasDate:
$ref: '#/components/schemas/ToGasDate'
BuyerName:
$ref: '#/components/schemas/BuyerName'
SellerName:
$ref: '#/components/schemas/SellerName'
FacilityId:
$ref: '#/components/schemas/FacilityId'
FacilityName:
$ref: '#/components/schemas/FacilityName'
FlowDirection:
$ref: '#/components/schemas/FlowDirection'
StandardOTSA:
$ref: '#/components/schemas/StandardOTSA'
BBTransportationServiceType:
$ref: '#/components/schemas/BBTransportationServiceType'
Priority:
$ref: '#/components/schemas/Priority'
ReceiptPointId:
$ref: '#/components/schemas/ReceiptPointId'
Quantity:
$ref: '#/components/schemas/Quantity'
MHQ:
$ref: '#/components/schemas/MHQ'
Price:
$ref: '#/components/schemas/Price'
PriceStructure:
$ref: '#/components/schemas/PriceStructure'
PriceEscalationMechanism:
$ref: '#/components/schemas/PriceEscalationMechanism'
example:
TradeId: 123456
TradeDate: '2018-03-01'
FromGasDate: '2018-03-10'
ToGasDate: '2018-03-20'
BuyerName: Star Energy
SellerName: ENERGYCO1
FacilityId: 520001
FacilityName: Tamworth pipeline
FlowDirection: NORTH
StandardOTSA: 'true'
BBTransportationServiceType: FORWARD_HAUL
Priority: Secondary firm
ReceiptPointId: 3001
Quantity: 240
MHQ: 10
Price: 4.2
PriceStructure: Variable
PriceEscalationMechanism: 10% per annum
responses:
'200':
description: Successful
/BBCapacityTransactionReport:
get:
summary: Get capacity transaction declarations through the Bulletin Board
description: 'Provides information on BB Capacity Transactions, excluding those concluded through the gas trading exchange.'
operationId: getBBCapacityTransactionReport
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful Resonse with BBCapacityTransactionDataList
content:
application/json:
schema:
example:
transactionId: 3f4f58d6-8daa-4bd9-aac5-2bc864abbf42
data:
BBCapacityTransactionDataList: [ ]
errors: [ ]
warnings: [ ]
example:
transactionId: 3f4f58d6-8daa-4bd9-aac5-2bc864abbf42
data:
BBCapacityTransactionDataList: [ ]
errors: [ ]
warnings: [ ]
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
/registeredParticipantCode:
get:
summary: Get participant code
description: Get participant code
operationId: getRegisteredParticipantCode
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: registeredParticipantCode
post:
summary: Add new participant code
description: Register participants code
operationId: postRegisteredParticipantCode
parameters:
- name: X-initiatingParticipantID
in: header
description: The ID of the Initiating Participant
required: true
schema:
type: string
- name: X-market
in: header
description: The market type that the request applies.
required: true
schema:
type: string
responses:
'200':
description: Successful request.
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
schema:
example:
Fault: <SystemMessageExceptionDump>
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password is incorrect/not provided OR user account is locked out.
content:
application/json:
schema:
example:
Exception: Unauthorized:Invalid UserName or Password
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have permission to submit this request.
'404':
description: This response is provided when the resource missing from URL or incorrect.
content:
application/json:
schema:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
schema:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: 'This response is provided when any there are any Business validation failures, then entire submission is rejected.'
content:
application/json:
schema:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
example:
data: { }
errors:
- code: 73
title: InvalidBuySell
detail: BuySell value 24.1 is not valid
source:
'429':
description: This response is provided when the throttling limits are reached.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
'503':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
schema:
example:
Exception: Application Unavailable
example:
Exception: Application Unavailable
components:
schemas:
TradeId:
type: integer
description: A unique AEMO defined trade identifier. This field is mandatory when updating an existing trade.
example: 123456
TradeDate:
type: string
description: Date the trade was made.
example: '2018-03-01'
FromGasDate:
type: string
description: Effective start date of the trade
example: '2018-03-10'
ToGasDate:
type: string
description: Effective end date of the trade
example: '2018-03-20'
BuyerName:
maxLength: 255
type: string
description: The descriptive name of the buyer
example: Star Energy
SellerName:
maxLength: 255
type: string
description: The descriptive name of the seller
example: ENERGYCO1
FacilityId:
type: integer
description: The unique AEMO defined Part 24 Facility Identifier. This information is mandatory for facilities registered in CTP or DAA. Otherwise leave this blank.
example: 520001
FacilityName:
maxLength: 255
type: string
description: The descriptive name of the Facility that is not registered as a Part 24 Facility. This information is mandatory for facilities registered in CTP or DAA. Otherwise leave this blank.
example: Tamworth pipeline
FlowDirection:
maxLength: 10
enum:
- NORTH
- NORTH_EAST
- NORTH_WEST
- EAST
- SOUTH
- SOUTH_EAST
- SOUTH_WEST
- WEST
type: string
description: The directional of flow relative to the general direction of the facility that is not registered as a Part 24 facility. This information is mandatory for facilities registered in CTP or DAA. Otherwise leave this blank.
StandardOTSA:
maxLength: 255
enum:
- 'true'
- 'false'
type: string
description: Identify if a standard OTSA was used
BBTransportationServiceType:
maxLength: 12
enum:
- FORWARD_HAUL
- BACKHAUL
- PARK
- LOAN
- COMPRESSION
type: string
description: The transportation service type.
Priority:
type: string
description: The priority of the traded capacity
example: Secondary firm
ReceiptPointId:
type: integer
description: 'The unique AEMO defined Receipt Part 24 Service Point identifier. This is the point where gas is injected into the pipeline. This information is mandatory for facilities registered in CTP or DAA and BB Transportation Service Type = FORWARD_HAUL, BACKHAUL or COMPRESSION'
example: 3001
DeliveryPointId:
type: integer
description: 'The unique AEMO defined Delivery Part 24 Service Point identifier. This is the point where gas is withdrawn from the pipeline. This information is mandatory for facilities registered in CTP or DAA and BB Transportation Service Type = FORWARD_HAUL, BACKHAUL or COMPRESSION'
example: 4001
ParkLoanPointId:
type: integer
description: The unique AEMO defined service point identifier for the Park and Loan point. This information is mandatory for facilities registered in CTP or DAA and BB Transportation Service Type = PARK or LOAN.
example: 5001
Quantity:
type: integer
description: The traded maximum daily quantity (MDQ) (GJ/day).
example: 240
MHQ:
type: integer
description: The traded maximum hourly quantity (GJ/hour).
example: 10
Price:
type: number
description: The price of the capacity traded ($/GJ/day).
example: 4.2
PriceStructure:
type: string
description: The price structure applied over the term of the trade.
example: Variable
PriceEscalationMechanism:
type: string
description: The price escalation mechanism applied over the term of the trade.
example: 10% per annum
ConnectionPointId:
type: integer
description: A unique AEMO defined connection point identifier.
example: 1301002
CapacityQuantity:
type: number
description: Standing capacity quantity in TJ to three decimal places. Three decimal places is not required if the value has trailing zeros after the decimal place.
example: 201.65
EffectiveDate:
type: string
description: Gas day date that corresponding record takes effect. Any time component supplied will be ignored
example: '2018-08-06'
Description:
type: string
description: Facility use is restricted to a description for reasons or comments directly related to the capacity quantity or change in quantity in relation to a facility
example: This is some comments
GasDate:
type: string
description: Date of gas day. Timestamps are ignored. The gas day as defined in the pipeline contract or market rules.
example: '2018-09-23'
ActualQuantity:
type: number
description: The actual flow or compressed quantity reported in TJ to the nearest gigajoule with three decimal places. Three decimal places are not required if the value has trailing zeros after the decimal place. This information is mandatory when Quality value is “OK”.
example: 32.232
Quality:
maxLength: 3
enum:
- OK
- NIL
type: string
description: 'Indicates whether meter data for the submission date is available. Values can be either - OK — Connection point Actual Quantity data for gas flow into or out of a BB facility based on meter data, or NIL — Connection Point Actual Quantity data for gas flow into or out of a BB facility cannot be determined due to an operational issue.'
Flag:
maxLength: 5
enum:
- GREEN
- AMBER
- RED
type: string
description: 'The flags are traffic light colours (Green, Amber, Red) indicating the LCA status for each pipeline. - GREEN - Pipeline is able to accommodate increased gas flows. - AMBER - Pipeline is flowing at full capacity, but no involuntary curtailment of ‘firm’ load is likely or happening. - RED - Involuntary curtailment of ‘firm’ load is likely or happening.'
CapacityType:
maxLength: 10
enum:
- STORAGE
- MDQ
type: string
description: "Capacity type values can be - \n- STORAGE — Holding capacity in storage; \n- MDQ — Daily maximum firm capacity under the expected operating conditions.\nThis field can be left blank if all other fields (excluding Facility Id) are also left blank. This clears all existing future dated Medium Term Capacity Outlook submissions."
OutlookQuantity:
type: number
description: Capacity outlook quantity in TJ to three decimal places. Three decimal places is not required if the value has trailing zeros after the decimal place. This field can be left blank if all other fields (excluding Facility Id) are also left blank. This clears all existing future dated Medium Term Capacity Outlook submissions.
example: 200.531
CapacityDescription:
maxLength: 800
type: string
description: 'Free text to describe the meaning of the capacity number provided, including a description of material factors that impact the capacity number and any other relevant information. This information is mandatory for BB pipeline submissions with a MDQ Capacity Type. Otherwise leave this blank.'
example: This transmission capacity is the amount of gas that the Culcairn delivery point is able to withdraw from this pipeline facility. This capacity is dependent on the forecast DTS demand and the availability of key assets on this pipeline facility
ReceiptLocation:
type: integer
description: The Connection Point Id that best represents the receipt location. The Receipt Location in conjunction with the Delivery Location indicates the capacity direction and location. This information is mandatory for BB pipeline submissions with a MDQ Capacity Type. Otherwise leave this blank..
example: 1200001
DeliveryLocation:
type: integer
description: The Connection Point Id that best represents the Delivery Location. The Delivery Location in conjunction with the receipt Location indicates the capacity direction and location. This information is mandatory for BB pipeline submissions with a MDQ Capacity Type. Otherwise leave this blank.
example: 1300056
NominationQuantity:
type: number
description: Receipt or delivery nomination quantity in TJ to three decimal places. Three decimal places is not required if the value has trailing zeros after the decimal place.
example: 32.561
OutlookMonth:
type: integer
description: The outlook month.
example: 4
OutlookYear:
type: integer
description: The outlook year.
example: 2018
securitySchemes:
apiKeyHeader:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
apiKeyQuery:
type: apiKey
name: subscription-key
in: query
security:
- apiKeyHeader: [ ]
- apiKeyQuery: [ ]