AEMO EnablementInstruction

openapi: 3.0.1
info:
  title: EnablementInstruction
  version: '3.0'
  x-origin:
  - format: openapi
    source: AEMO API Management developer portal
    url: https://dev.aemo.com.au/developer/apis/enablementinstruction-v1/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/NEM/v1/ISF-External/enablementInstruction
paths:
  /deliveredEnablementInstructions:
    get:
      operationId: thisIsToViewTheInstructionsSentOutToTheParticipants
      summary: This is to view the instructions sent out to the participants.
      tags:
      - EnablementInstruction
      description: Allows you to view the Current and Historical Instruction records in the Enablement
        Instructions screen along with pre-poulated drop drown from the Instruction Table.
      parameters:
      - name: instructionDisplayType
        in: query
        required: false
        schema:
          type: string
          enum:
          - current
          - historical
      - name: X-initiatingParticipantID
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Initiating Participant
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Required Base64 encoding of your URM username and password, concatenated with a colon
          and a TLS Certificate.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              example: ''
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
                enablementDetailsRes:
                - duid: string
                  contractId: string
                  regionId: string
                  serviceType: string
                  providerParticipant: string
                  tnspParticipant: string
                  enablementInstructionResults:
                  - initiatingInstructionId: string
                    instructions:
                    - transactionId: string
                      initiatingTransactionId: string
                      enablementStatus: string
                      duidName: string
                      duid: string
                      enabledUnits: 0
                      instructionDispatchMinMW: 0
                      equipType: string
                      minEnablementDuration: 0
                      activationLeadTime: 0
                      startDate: string
                      startTime: string
                      endDate: string
                      endTime: string
                      createdDate: string
                      createdTime: string
                      contractId: string
                      regionid: string
                      serviceType: string
                      isParent: true
            text/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
                enablementDetailsRes:
                - duid: string
                  contractId: string
                  regionId: string
                  serviceType: string
                  providerParticipant: string
                  tnspParticipant: string
                  enablementInstructionResults:
                  - initiatingInstructionId: string
                    instructions:
                    - transactionId: string
                      initiatingTransactionId: string
                      enablementStatus: string
                      duidName: string
                      duid: string
                      enabledUnits: 0
                      instructionDispatchMinMW: 0
                      equipType: string
                      minEnablementDuration: 0
                      activationLeadTime: 0
                      startDate: string
                      startTime: string
                      endDate: string
                      endTime: string
                      createdDate: string
                      createdTime: string
                      contractId: string
                      regionid: string
                      serviceType: string
                      isParent: true
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                example1:
                  summary: Specified value for submittedFrom is in the wrong format
                  value:
                    transactionId: 02bc8aa5-b114-4f2c-9a86-0156fc3daecb
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Date needs to be formatted as YYYY-MM-DD without time information
                      source:
                        parameter: submittedfrom=2021-11-13T08:00
                example2:
                  summary: Specified value for submittedTo is in the wrong format
                  value:
                    transactionId: 02bc8aa5-b114-4f2c-9a86-0156fc3daecb
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Date needs to be formatted as YYYY-MM-DD without time information
                      source:
                        parameter: submittedto=2021-11-13T08:00
                example3:
                  summary: No value specified for submittedTo when submittedFrom is specified
                  value:
                    transactionId: 66245c08-25c2-4b77-b6cf-344e0c7e2279
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: '''submittedto'' is required when ''submittedfrom'' is specified'
                      source:
                        parameter: submittedto
                example4:
                  summary: No value specified for submittedFrom when submittedTo is specified
                  value:
                    transactionId: 66245c08-25c2-4b77-b6cf-344e0c7e2279
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: '''submittedfrom'' is required when ''submittedto'' is specified'
                      source:
                        parameter: submittedfrom
                example5:
                  summary: Specified value for submittedTo is more than 30 days after specified value
                    for submittedFrom
                  value:
                    transactionId: d6fec39d-22ea-45b2-8d05-30f0ec17458a
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Query dates range must be within 30 days
                      source:
                        parameter: submittedfrom=2021-11-01&submittedto=2021-12-01
                example6:
                  summary: Specified value for submittedFrom is before specified value for submittedTo
                  value:
                    transactionId: 70c79caa-639c-4929-8c1e-2327e6f7d895
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: '''submittedto'' must not be before ''submittedfrom'''
                      source:
                        parameter: submittedfrom=2021-11-01&submittedto=2021-10-31
                example7:
                  summary: Specified value for submissionType is not one of the allowable values
                  value:
                    transactionId: cb69c31c-75b7-47fa-a140-925519139793
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: 'The given value is not one of the valid options: Standing, Variation, Invalid'
                      source:
                        parameter: submissiontype=Valid
                example8:
                  summary: Specified value for status is not one of the allowable values
                  value:
                    transactionId: 45d102b9-4a5a-41e2-85d7-9609931715b6
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: 'The given value is not one of the valid options: Submitted, Valid, Rejected,
                        Failed'
                      source:
                        parameter: status=accepted
                example9:
                  summary: Specified value for statusUpdatedSince is in the wrong format
                  value:
                    transactionId: 3b45d936-985f-41b6-9fac-cfcf367e5f1b
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Datetime needs to be formatted according to ISO8601 format with time information
                      source:
                        parameter: statusupdatedsince
                example10:
                  summary: Specified Value for marketService is not one of the allowable values
                  value:
                    transactionId: ceb95ee3-d845-42f8-9b0a-71776c6403e9
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: 'The given value is not one of the valid options: ContingencyLower, ContingencyRaise,
                        Energy, RegulationLower, RegulationRaise, Rocof'
                      source:
                        parameter: marketservice=regulation_lower
                example11:
                  summary: Specified value for tradingDay is in the wrong format
                  value:
                    transactionId: a5b74fd6-a52d-4e77-acf1-0eb354d32250
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Date needs to be formatted as YYYY-MM-DD without time information
                      source:
                        parameter: tradingday=2021-11-23 08:00
                example12:
                  summary: Specified value for hasGateClosureViolation is not one of the allowable values
                  value:
                    transactionId: 549f7736-90c4-41d8-ba90-f7e10dc69bfb
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: 'The given value is not one of the valid options: true, false'
                      source:
                        parameter: hasgateclosureviolation=Yes
                example13:
                  summary: A value is specified for hasGateClosureViolation when the specified value for
                    submissionStatus is not 'valid'
                  value:
                    transactionId: 8c7aef18-dc9a-4567-9356-5d42f581a436
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: When 'HasGateClosureViolation' is specified, the only status which may be
                        specified is Valid
                      source:
                        parameter: hasgateclosureviolation&status
                example14:
                  summary: The specified referenceId is longer than the allowable length
                  value:
                    transactionId: 9cee04af-3b0b-42d4-8e10-c8a840a20ef5
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Reference ID must be 100 characters or less
                      source:
                        parameter: referenceid=submission123456789_...
                example15:
                  summary: A specified parameter not allowed
                  value:
                    transactionId: e6641ec2-b459-4fb9-b907-25cddf2237f2
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Parameter is not allowed
                      source:
                        parameter: submissionstatus
                example16:
                  summary: The specified value for a parameter is missing or blank
                  value:
                    transactionId: ceb95ee3-d845-42f8-9b0a-71776c6403e9
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Value for parameter referenceid must be specified
                      source:
                        parameter: referenceid=
                example17:
                  summary: A parameter has been specified more than once
                  value:
                    transactionId: f86fd16f-8fe3-4ded-95f2-57d2d2b2f24a
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Duplicated parameter key is received
                      source:
                        parameter: submissiontype
                example18:
                  summary: The specified value for statusUpdatedSince is in the wrong format
                  value:
                    transactionId: 3edf449a-372a-4133-894f-144d754ac15a
                    errors:
                    - code: ERR400
                      title: Bad Request
                      detail: Datetime needs to be formatted according to ISO8601 format with time information
                      source:
                        parameter: statusupdatedsince
                missingHeader:
                  summary: Missing mandatory HTTP header parameter
                  value:
                    transactionId: 61361d96-f20d-43a7-bkdf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '400'
                      title: Missing mandatory HTTP header parameter
                      detail: Mandatory HTTP header <headerName> is missing
                      source: ''
        '401':
          description: API Authentication failure
          content:
            application/json:
              examples:
                failedToAuthenticate:
                  value:
                    transactionId: e1ef1e6d-2945-4d42-a2e4-977dcc922079
                    errors:
                    - code: ERR401
                      title: Authentication Failure
                      detail: Failed to authenticate the credentials provided for this request.
                      source: ''
                unauthorized:
                  summary: Unauthorized
                  value:
                    transactionId: 9a8e902a-ed40-45f3-b075-7a644b12947f
                    data: {}
                    errors:
                    - code: '401'
                      title: Unauthorized
                      detail: Unauthorized
                      source: ''
                initiatingParticipantIdMismatch:
                  summary: x-initiatingParticipantId does not match with participant id associated with
                    certificate
                  value:
                    transactionId: 9a8e902a-ed40-45f3-u475-7a644b12947f
                    data: {}
                    errors:
                    - code: '401'
                      title: Unauthorized
                      detail: x-initiatingParticipantId does not match with participant id associated
                        with certificate
                      source: ''
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                resourceNotFound:
                  summary: Resource Not Found
                  value:
                    transactionId: 61361d96-f09d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '404'
                      title: Not Found
                      detail: Resources for the endpoint URI not found. Endpoint URI:<URI>
                      source: ''
        '405':
          description: Method not allowed
          content:
            application/json:
              examples:
                methodNotAllowed:
                  summary: Method Not Allowed
                  value:
                    transactionId: 61361d96-z20d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '405'
                      title: Method Not Allowed
                      detail: 'Input request HTTP method is <invokedMethod> but operation <operationURI>
                        accepts only: [<operationMethod>]'
                      source: ''
        '413':
          description: Payload Too Large
          content:
            application/json:
              examples:
                payloadTooLarge:
                  summary: Payload Too Large
                  value:
                    transactionId: dc6826bc-1c0d-498b-b474-2b231910860c
                    data: {}
                    errors:
                    - code: '413'
                      title: Payload Too Large
                      detail: Maximum allowed size for the <request/response> body is <payload size limit>
                        bytes (<size limit> MB). This <request/response> has size of <number of bytes>
                        bytes
                      source: ''
        '422':
          description: Unprocessable Content
          content:
            text/plain:
              example: ''
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
        '429':
          description: Too many request
          content:
            application/json:
              examples:
                tooManyRequests:
                  summary: Too Many Requests
                  value:
                    transactionId: 63361d96-f20d-43a7-babf-59b35fab9b13
                    data: {}
                    errors:
                    - code: '429'
                      title: Too Many Requests
                      detail: Number of inbound requests exceeded the throttling limits; try after sometime
                      source: ''
        '500':
          description: Internal Server Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  source: string
                warnings:
                - code: string
                  title: string
                  detail: string
                  source: string
                infos:
                - code: string
                  title: string
                  detail: string
                  source: string
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: EnablementInstruction
  description: EnablementInstruction