openapi: 3.0.1
info:
  title: RCM Operations
  version: '1.0'
  x-origin:
  - format: openapi
    version: '3.0'
    source: AEMO API Management developer portal
    url: https://dev.aemo.com.au/developer/apis/rcm-ops-external-v1/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/WEM/RCM
paths:
  /api/v1/CapacityYears/Facilities/SeparatelyCertifiedComponents/{tradingDay}:
    get:
      operationId: apiV1CapacityYearsFacilitiesSeparatelyCertifiedComponentsTradingDayGET
      summary: /api/v1/CapacityYears/Facilities/SeparatelyCertifiedComponents/{tradingDay} - GET
      tags:
      - RCM Operations
      description: /api/v1/CapacityYears/Facilities/SeparatelyCertifiedComponents/{tradingDay} - GET
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339).
      - name: participantId
        in: query
        required: false
        schema:
          type: string
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    indicativeFacilityClass: string
                    separatelyCertifiedComponentsViewModels:
                    - sccCode: string
                      technologyType: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/RelevantDemand/{capacityYearId}/TwoHundredPeakHours:
    get:
      operationId: aListOfTwoHundredHoursWithTheHighestGeneration
      summary: A list of two hundred hours with the highest generation
      tags:
      - RCM Operations
      description: "This returns a CSV with a header and two hundred subsequent rows, representing the\
        \ intervals of the highest periods of generation in the capacity market and the corresponding\
        \ generation quantity (in MW). Eg:\r\n           \r\n           \r\n           Hour Interval,Value\r\
        \n           12/01/2016 14:30,35037.00\r\n           15/01/2016 13:00,35033.00\r\n           ..."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. ID of the capacity year to query (eg 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/flexible/{capacityYear}/standing:
    get:
      operationId: retrievesAFlexibleCCAStandingSubmissionListForACapacityYear
      summary: Retrieves a Flexible CCA Standing Submission List for a Capacity Year.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to retrieve their Flexible Capacity Credit\
        \ Allocation Standing Submission List for the given Capacity Year.\r\n<br /><br />\r\nNote: This\
        \ method is only available from Capacity Year 2027."
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: 'Format - int32. The Capacity Year associated with the request (Format: YYYY, e.g.
          2027)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  standingSubmissions:
                  - capacityYear: 0
                    participantCode: string
                    standingSubmissionItems:
                    - entityCode: string
                      entityType: string
                      targetParticipantCode: string
                      flexibleCapacityCredits: 0
                      order: 0
            text/json:
              example:
                transactionId: {}
                data:
                  standingSubmissions:
                  - capacityYear: 0
                    participantCode: string
                    standingSubmissionItems:
                    - entityCode: string
                      entityType: string
                      targetParticipantCode: string
                      flexibleCapacityCredits: 0
                      order: 0
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
    post:
      operationId: submitsAFlexibleCCAStandingSubmissionListForACapacityYear
      summary: Submits a Flexible CCA Standing Submission List for a Capacity Year.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to submit a Flexible Capacity Credit Allocation\
        \ Standing Submission for a Capacity Year.\r\n<br /><br />\r\nNote: This method is only available\
        \ from Capacity Year 2027."
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: 'Format - int32. The Capacity Year associated with the request (Format: YYYY, e.g.
          2027)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      requestBody:
        content:
          application/json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
              order: 0
          text/json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
              order: 0
          application/*+json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
              order: 0
        description: JSON object containing the details to submit the standing submission
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data: {}
            text/json:
              example:
                transactionId: {}
                data: {}
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/flexible/received:
    get:
      operationId: retrievesAListOfApprovedFlexibleCCAsReceivedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of approved Flexible CCAs received by a Market Participant for a range
        of Trading Days.
      tags:
      - RCM Operations
      description: "This method retrieves a list of Flexible Capacity Credit Allocation received by a\
        \ Market Participant for a range of Trading Days.\r\n<br /><br />\r\nNote: This method is only\
        \ available from Capacity Year 2027."
      parameters:
      - name: tradingDayFrom
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the start of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2027-10-01)'
      - name: tradingDayTo
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the end of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2027-10-31)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    flexibleCapacityCredits: 0
                    status: string
                    lastActionResult: string
            text/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    flexibleCapacityCredits: 0
                    status: string
                    lastActionResult: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/peak/received:
    get:
      operationId: retrievesAListOfApprovedPeakCCAsReceivedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of approved Peak CCAs received by a Market Participant for a range of
        Trading Days.
      tags:
      - RCM Operations
      description: "This method retrieves a list of Peak Capacity Credit Allocation received by a Market\
        \ Participant for a range of Trading Days. \r\n<br /><br />\r\nNote: This method is only available\
        \ from Capacity Year 2026."
      parameters:
      - name: tradingDayFrom
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the start of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2026-10-01)'
      - name: tradingDayTo
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the end of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2026-10-31)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    peakCapacityCredits: 0
                    status: string
                    lastActionResult: string
            text/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    peakCapacityCredits: 0
                    status: string
                    lastActionResult: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocations/Amendments/{tradingMonth}:
    get:
      operationId: retrievesAListOfCapacityAllocationAmendmentRequestsForExistingCapacityCreditAllocationsTheCapacityYearAndTradingMonth
      summary: Retrieves a list of capacity allocation amendment requests for existing Capacity Credit
        Allocations the Capacity Year and Trading Month
      tags:
      - RCM Operations
      description: "This method returns a list of Capacity Credit Allocations that are required to be\
        \ amended. Only the amendment requests relating to that Market Generator are returned.\r\n<br\
        \ />\r\nNote:\r\nProvides a list of Capacity Credit Allocations that are required to be amended\
        \ and the corresponding Facilities\r\nassociated with those Capacity Credit Allocations. Only\
        \ the amendment requests relating to that Market Participant\r\nthat submitted the Capacity Credit\
        \ Allocation are returned.\r\n<br /><br />\r\nNote: This method is only available from Trading\
        \ Month June 2019 (with the implementation of Rule Change RC_2017_06).\r\n<br />\r\nNote: From\
        \ Capacity Year 2023 onwards, this API is no longer available.\r\n<br />\r\nThe breakdown of CCA\
        \ IDs to be amended by Facility is only available for Capacity Allocations for Trading Month\r\
        \nOctober 2021 onwards arising from the Wholesale Electricity Market Amendment(Reserve Capacity\
        \ Pricing Reforms)\r\nRules 2019. The response field “sourceFacilityId” will return \"\" for TradingMonth\
        \ before October 2021."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the amendment requests (format: "MMM" e.g.''OCT'', ''AUG'')'
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  participantName: string
                  sourceFacilityId: string
                  targetCca: 0
                  amendmentDue: string
                  status: string
                  capacityAllocationAmendmentRequestFacilityViewModels:
                  - ccaId: 0
            text/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  participantName: string
                  sourceFacilityId: string
                  targetCca: 0
                  amendmentDue: string
                  status: string
                  capacityAllocationAmendmentRequestFacilityViewModels:
                  - ccaId: 0
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocations/Transactions/{tradingMonth}:
    get:
      operationId: retrievesAListOfCapacityCreditAllocationTransactionsForTheTradingMonth
      summary: Retrieves a list of Capacity Credit Allocation transactions for the Trading Month
      tags:
      - RCM Operations
      description: "Provides a list of transactions related to Capacity Credit Allocations submitted or\
        \ received for a\r\nTrading Month and the corresponding Facilities assocaited with those Capacity\
        \ Credit Allocations.\r\nOnly the transactions relating to that Market Participant are returned.\r\
        \n<br /><br />\r\nNote: This method is only available from Trading Month June 2019 (with the implementation\
        \ of Rule ChangeRC_2017_06.\r\n<br />\r\nNote: From Capacity Year 2023 onwards, this API is no\
        \ longer available.\r\n<br />\r\nThe sourceFacilityId field is only available for Capacity Allocations\
        \ for Trading Month October 2021 onwards\r\narising from the Wholesale Electricity Market Amendment(Reserve\
        \ Capacity Pricing Reforms) Rules 2019. The\r\nresponse field “sourceFacilityId” will return \"\
        \" for TradingMonth before October 2021."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the capacity allocation transactions (format: "MMM" eg:''OCT'',
          ''AUG'')'
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityAllocationId: 0
                  capacityYearId: 0
                  submitter: string
                  submitterName: string
                  type: string
                  previousStatus: string
                  newStatus: string
                  participantId: string
                  participantName: string
                  sourceFacilityId: string
                  targetParticipantId: string
                  targetParticipantName: string
                  previousCca: 0
                  newCca: 0
                  timestamp: string
                  transactionStatus: string
                  transactionReason: string
            text/json:
              example:
                data:
                - id: 0
                  capacityAllocationId: 0
                  capacityYearId: 0
                  submitter: string
                  submitterName: string
                  type: string
                  previousStatus: string
                  newStatus: string
                  participantId: string
                  participantName: string
                  sourceFacilityId: string
                  targetParticipantId: string
                  targetParticipantName: string
                  previousCca: 0
                  newCca: 0
                  timestamp: string
                  transactionStatus: string
                  transactionReason: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/Received:
    get:
      operationId: retrievesAListOfCapacityCreditAllocationsReceivedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of capacity credit allocations received by a market participant for a
        range of trading days
      tags:
      - RCM Operations
      description: "This method retrieves a list of Capacity Credit Allocation Submissions received by\
        \ a market participant for a range of trading days within the capacity year.\r\nNote: This method\
        \ is only available from Capacity Year 2023 (with the implementation of WEM Reform).\r\n<br /><br\
        \ />\r\nNote: From Capacity Year 2026 onwards, this API is no longer available.\r\n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: dateFrom
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          start of the request e.g. 2023-10-01
      - name: dateTo
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          end of the request e.g. 2023-11-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/{tradingDay}/Received:
    get:
      operationId: retrievesAListOfCapacityCreditAllocationsReceivedByAMarketParticipantForATradingDay
      summary: Retrieves a list of capacity credit allocations received by a market participant for a
        trading day
      tags:
      - RCM Operations
      description: "This method retrieves a list of Capacity Credit Allocation Submissions received by\
        \ a market participant for a trading day within the capacity year.\r\n<br /><br />\r\nNote: This\
        \ method is only available from Capacity Year 2023 (with the implementation of WEM Reform).\r\n\
        <br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer available.\r\n<br\
        \ />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          capacity credit allocation submission e.g. 2023-10-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/Submitted:
    get:
      operationId: retrievesAListOfCapacityCreditAllocationsSubmittedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of capacity credit allocations submitted by a market participant for a
        range of trading days
      tags:
      - RCM Operations
      description: "This method retrieves a list of Capacity Credit Allocation Submissions submitted by\
        \ a market participant for a range of trading days within the capacity year.\r\n<br /><br />\r\
        \nNote: This method is only available from Capacity Year 2023 (with the implementation of WEM\
        \ Reform).\r\n<br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer available.\r\
        \n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: dateFrom
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          start of the request e.g. 2023-10-01
      - name: dateTo
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          end of the request e.g. 2023-11-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/{tradingDay}/Submitted:
    get:
      operationId: retrievesAListOfCapacityCreditAllocationsSubmittedByAMarketParticipantForATradingDay
      summary: Retrieves a list of capacity credit allocations submitted by a market participant for a
        trading day
      tags:
      - RCM Operations
      description: "This method retrieves a list of Capacity Credit Allocation Submissions submitted by\
        \ a market participant for a trading day within the capacity year.\r\n<br /><br />\r\nNote: This\
        \ method is only available from Capacity Year 2023 (with the implementation of WEM Reform).\r\n\
        <br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer available.\r\n<br\
        \ />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          capacity credit allocation submission e.g. 2023-10-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
    post:
      operationId: submitsACapacityCreditAllocationInRespectOfAFacilityForATradingDay
      summary: Submits a capacity credit allocation in respect of a facility for a trading day
      tags:
      - RCM Operations
      description: "This method allows a market participant to submit a Capacity Credit Allocation Submission\
        \ in respect of a facility for a trading day within the capacity year, when the window is open.\r\
        \n<br /><br />\r\nNote: This method is only available from Capacity Year 2023 (with the implementation\
        \ of WEM Reform).\r\n<br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer\
        \ available.\r\n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          capacity credit allocation submission e.g. 2023-10-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      requestBody:
        content:
          application/json:
            example:
              facilityCode: string
              targetParticipantCode: string
              capacityCredits: 0
          text/json:
            example:
              facilityCode: string
              targetParticipantCode: string
              capacityCredits: 0
          application/*+json:
            example:
              facilityCode: string
              targetParticipantCode: string
              capacityCredits: 0
        description: JSON object containing the details to submit the allocation
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
            text/json:
              example:
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  facilityCode: string
                  targetParticipantCode: string
                  capacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: Client Error
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/flexible/submitted:
    get:
      operationId: retrievesAListOfFlexibleCCAsSubmittedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of Flexible CCAs submitted by a Market Participant for a range of Trading
        Days.
      tags:
      - RCM Operations
      description: "This method retrieves a list of Flexible Capacity Credit Allocation Submissions submitted\
        \ by a Market Participant for a range of Trading Days.\r\n<br /><br />\r\nNote: This method is\
        \ only available from Capacity Year 2027."
      parameters:
      - name: tradingDayFrom
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the start of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2027-10-01)'
      - name: tradingDayTo
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the end of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2027-10-31)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    flexibleCapacityCredits: 0
                    status: string
                    lastActionResult: string
            text/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    flexibleCapacityCredits: 0
                    status: string
                    lastActionResult: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/peak/submitted:
    get:
      operationId: retrievesAListOfPeakCCAsSubmittedByAMarketParticipantForARangeOfTradingDays
      summary: Retrieves a list of Peak CCAs submitted by a Market Participant for a range of Trading
        Days.
      tags:
      - RCM Operations
      description: "This method retrieves a list of Peak Capacity Credit Allocation Submissions submitted\
        \ by a Market Participant for a range of Trading Days.\r\n<br /><br />\r\nNote: This method is\
        \ only available from Capacity Year 2026."
      parameters:
      - name: tradingDayFrom
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the start of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2026-10-01)'
      - name: tradingDayTo
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day at the end of the
          range in the request (inclusive) (Format: YYYY-MM-DD, e.g. 2026-10-31)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    peakCapacityCredits: 0
                    status: string
                    lastActionResult: string
            text/json:
              example:
                transactionId: {}
                data:
                  allocations:
                  - id: 0
                    capacityYear: 0
                    tradingDay: string
                    participantCode: string
                    entityCode: string
                    entityType: string
                    targetParticipantCode: string
                    peakCapacityCredits: 0
                    status: string
                    lastActionResult: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/OpenTradingDays:
    get:
      operationId: retrievesAListOfTradingDaysForWhichTheCapacityCreditAllocationWindowIsOpen
      summary: Retrieves a list of trading days for which the capacity credit allocation window is open
      tags:
      - RCM Operations
      description: "This method retrieves a list of trading days for which the Capacity Credit Allocation\
        \ Window is open, in relation to the timestamp.\r\n<br /><br />\r\nNote: This method is only available\
        \ from Capacity Year 2023 (with the implementation of WEM Reform).\r\n<br /><br />\r\nNote: From\
        \ Capacity Year 2026 onwards, this API is no longer available.\r\n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the trading days (e.g. 2023).
      - name: asAt
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The timestamp associated with the request
          (e.g. 2022-02-28T17:00:59)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - string
            text/json:
              example:
                data:
                - string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/{capacityYear}/openTradingDays:
    get:
      operationId: retrievesAListOfTradingDaysForWhichTheCCAWindowIsOpenInRespectOfTheAsAt
      summary: Retrieves a list of Trading Days for which the CCA window is open in respect of the asAt.
      tags:
      - RCM Operations
      description: "This method returns a list of Trading Days for which the CCA Window is open, calculated\
        \ using the CCA Window Length.\r\n<br></br>\r\nNote: This method is only available from Capacity\
        \ Year 2026."
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: 'Format - int32. The Capacity Year associated with the request (Format: YYYY, e.g.
          2026)'
      - name: asAt
        in: query
        required: false
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The as at timestamp associated with
          the request (Format: YYYY-MM-DDTHH:mm:ss, e.g. 2026-07-22T16:26:00)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  openTradingDays:
                  - string
            text/json:
              example:
                transactionId: {}
                data:
                  openTradingDays:
                  - string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/peak/{capacityYear}/standing:
    get:
      operationId: retrievesAPeakCCAStandingSubmissionListForACapacityYear
      summary: Retrieves a Peak CCA Standing Submission List for a Capacity Year.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to retrieve their Peak Capacity Credit Allocation\
        \ Standing Submission List for the given Capacity Year.\r\n<br /><br />\r\nNote: This method is\
        \ only available from Capacity Year 2026."
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: 'Format - int32. The Capacity Year associated with the request (Format: YYYY, e.g.
          2026)'
      - name: participantCode
        in: query
        required: false
        schema:
          type: string
        description: The code of the Market Participant associated with the request
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  standingSubmissions:
                  - capacityYear: 0
                    participantCode: string
                    standingSubmissionItems:
                    - entityCode: string
                      entityType: string
                      targetParticipantCode: string
                      peakCapacityCredits: 0
                      order: 0
            text/json:
              example:
                transactionId: {}
                data:
                  standingSubmissions:
                  - capacityYear: 0
                    participantCode: string
                    standingSubmissionItems:
                    - entityCode: string
                      entityType: string
                      targetParticipantCode: string
                      peakCapacityCredits: 0
                      order: 0
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
    post:
      operationId: submitsAPeakCCAStandingSubmissionListForACapacityYear
      summary: Submits a Peak CCA Standing Submission List for a Capacity Year.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to submit a Peak Capacity Credit Allocation\
        \ Standing Submission for a Capacity Year.\r\n<br /><br />\r\nNote: This method is only available\
        \ from Capacity Year 2026."
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: 'Format - int32. The Capacity Year associated with the request (Format: YYYY, e.g.
          2026)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      requestBody:
        content:
          application/json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
              order: 0
          text/json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
              order: 0
          application/*+json:
            example:
            - entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
              order: 0
        description: JSON object containing the details to submit the standing submission
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data: {}
            text/json:
              example:
                transactionId: {}
                data: {}
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocationMonths:
    get:
      operationId: retrievesCutoffDatesRelatingToCapacityCreditAllocations
      summary: Retrieves cutoff dates relating to Capacity Credit Allocations
      tags:
      - RCM Operations
      description: "This method returns the start and end dates for the Capacity Credit Allocation windows\
        \ for a given capacity year.\r\n<br /><br />\r\nNote: From Trading Month June 2019 (with the implementation\
        \ of Rule Change RC_2017_06), the Allocation window\r\nand the Acceptance window open/close at\
        \ the same time.\r\n<br />\r\nNote: From Capacity Year 2023 onwards, this API is no longer available."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - capacityYearId: 0
                  tradingMonth: string
                  allocationStart: string
                  allocationEnd: string
                  acceptanceStart: string
                  acceptanceEnd: string
            text/json:
              example:
                data:
                - capacityYearId: 0
                  tradingMonth: string
                  allocationStart: string
                  allocationEnd: string
                  acceptanceStart: string
                  acceptanceEnd: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/Ircr/{tradingMonth}/Files/Log:
    get:
      operationId: retrievesIRCRLOGReportData
      summary: Retrieves IRCR LOG report data
      tags:
      - RCM Operations
      description: "This method returns published IRCR LOG report data in csv format. Only data relating\
        \ to the requesting Market Participant are returned.\r\n<br /><br />\r\nNote: This method is only\
        \ available from Trading Month June 2019 (with the implementation of Rule Change RC_2017_06)."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the amendment requests (format: "MMM" e.g.''OCT'', ''AUG'')'
      - name: ircrType
        in: query
        required: false
        schema:
          type: string
        description: (required)<br /><b>The Ircr Run Type ie. 'Indicative', 'Initial', 'Adjustment1',
          'Adjustment2', 'Adjustment3'</b>
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/Ircr/{tradingMonth}/Log:
    get:
      operationId: retrievesIRCRLOGReportData2
      summary: Retrieves IRCR LOG report data
      tags:
      - RCM Operations
      description: "This method returns published IRCR LOG report data. Only data relating to the requesting\
        \ Market Participant are returned.\r\n<br /><br />\r\nNote: This method is only available from\
        \ Trading Month June 2019 (with the implementation of Rule Change RC_2017_06)."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the amendment requests (format: "MMM" e.g.''OCT'', ''AUG'')'
      - name: ircrType
        in: query
        required: false
        schema:
          type: string
        description: (required)<br /><b>The Ircr Run Type ie. 'Indicative', 'Initial', 'Adjustment1',
          'Adjustment2', 'Adjustment3'</b>
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  periodStart: string
                  periodEnd: string
                  ircrType: string
                  runId: 0
                  publishedTime: string
                  nmis:
                  - nmi: string
                    medianMwh: 0
                    monthFraction: 0
                    tdlFlag: true
                    newMeterFlag: true
            text/json:
              example:
                data:
                  periodStart: string
                  periodEnd: string
                  ircrType: string
                  runId: 0
                  publishedTime: string
                  nmis:
                  - nmi: string
                    medianMwh: 0
                    monthFraction: 0
                    tdlFlag: true
                    newMeterFlag: true
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/Ircr/{tradingMonth}/Files/Pir:
    get:
      operationId: retrievesIRCRPIRReportData
      summary: Retrieves IRCR PIR report data
      tags:
      - RCM Operations
      description: "This method returns published IRCR PIR report data in csv format. Only data relating\
        \ to the requesting Market Participant are returned.\r\n<br /><br />\r\nNote: This method is only\
        \ available from Trading Month June 2019 (with the implementation of Rule Change RC_2017_06)."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the amendment requests (format: "MMM" e.g.''OCT'', ''AUG'')'
      - name: ircrType
        in: query
        required: false
        schema:
          type: string
        description: (required)<br /><b>The Ircr Run Type ie. 'Indicative', 'Initial', 'Adjustment1',
          'Adjustment2', 'Adjustment3'</b>
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/Ircr/{tradingMonth}/Pir:
    get:
      operationId: retrievesIRCRPIRReportData2
      summary: Retrieves IRCR PIR report data
      tags:
      - RCM Operations
      description: "This method returns published IRCR PIR report data. Only data relating to the requesting\
        \ Market Participant are returned.\r\n<br /><br />\r\nNote: This method is only available from\
        \ Trading Month June 2019 (with the implementation of Rule Change RC_2017_06)."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the amendment requests (format: "MMM" e.g.''OCT'', ''AUG'')'
      - name: ircrType
        in: query
        required: false
        schema:
          type: string
        description: (required)<br /><b>The Ircr Run Type ie. 'Indicative', 'Initial', 'Adjustment1',
          'Adjustment2', 'Adjustment3'</b>
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  capacityYearId: 0
                  runId: 0
                  ircrType: string
                  periodStart: string
                  periodEnd: string
                  publishedTime: string
                  variables:
                  - variable: string
                    scope: string
                    value: 0
                    unit: string
            text/json:
              example:
                data:
                  capacityYearId: 0
                  runId: 0
                  ircrType: string
                  periodStart: string
                  periodEnd: string
                  publishedTime: string
                  variables:
                  - variable: string
                    scope: string
                    value: 0
                    unit: string
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/RequiredLevel/Adjusted/{tradingDay}:
    get:
      operationId: retrievesTheAdjustedRequiredValuesEffectiveOnTheProvidedTradingDayIfNoValuesExistForTheTradingDayButUnderlyingCapacityYearDataExistsTheAdjustedValuesWillBeCalculated
      summary: "Retrieves the adjusted required values effective on the provided trading day.\r\nIf no\
        \ values exist for the trading day, but underlying capacity year data exists, the adjusted values\
        \ will be calculated."
      tags:
      - RCM Operations
      description: "Retrieves the adjusted required values effective on the provided trading day.\r\n\
        If no values exist for the trading day, but underlying capacity year data exists, the adjusted\
        \ values will be calculated."
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day (e.g. 2024-01-01)
      - name: participantId
        in: query
        required: false
        schema:
          type: string
        description: The participant (e.g. GRIFFINP)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    adjustedRequiredLevels:
                    - effective:
                        from: string
                        to: string
                      value: 0
            text/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    adjustedRequiredLevels:
                    - effective:
                        from: string
                        to: string
                      value: 0
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocations/{tradingMonth}/Position:
    get:
      operationId: retrievesTheCapacityCreditAllocationPositionForTheTradingMonth
      summary: Retrieves the Capacity Credit Allocation position for the Trading Month
      tags:
      - RCM Operations
      description: "The position indicates the participant's tradeable Capacity Credits (in the event\
        \ of a Market Generator) and/or the participant's IRCR (in the event of a Market Customer). \r\
        \n<br /><br />\r\nNote: From Capacity Year 2023 onwards, this API is no longer available."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The month for the capacity allocations (format: "MMM" eg:''OCT'', ''AUG'')'
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  ircr: 0
                  allocatableCapacityCredits: 0
                  allocationsSubmittedOn: string
                  allocationsAcceptedOn: string
            text/json:
              example:
                data:
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  ircr: 0
                  allocatableCapacityCredits: 0
                  allocationsSubmittedOn: string
                  allocationsAcceptedOn: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v2/CapacityYears/{capacityYearId}/CapacityAllocations/{tradingMonth}/Position:
    get:
      operationId: retrievesTheCapacityCreditAllocationPositionsForTheTradingMonthAgainstEachFacility
      summary: Retrieves the Capacity Credit Allocation positions for the Trading Month against each Facility
      tags:
      - RCM Operations
      description: "This API provides a Participant’s overall allocatableCapacityCredits  and a break\
        \ down by Facility for that\r\nParticipant of each Facilities’ respective bilaterally tradeable\
        \ Capacity Credits. For a Market Customer it\r\nalso provides a Participant’s IRCR \r\n<br /><br\
        \ />\r\nNote: This method is only available for Capacity Allocations for Trading Month October\
        \ 2021 onwards arising\r\nfrom the Wholesale Electricity Market Amendment(Reserve Capacity Pricing\
        \ Reforms) Rules 2019. For calls for\r\nTrading Months before October 2021 this API will return\
        \ forbidden.\r\n<br />\r\nNote: From Capacity Year 2023 onwards, this API is no longer available."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2021)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The month for the capacity allocations (format: "MMM" eg:''OCT'', ''AUG'')'
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  ircr: 0
                  allocatableCapacityCredits: 0
                  facilityAllocatableCapacityCredits:
                  - sourceFacilityId: string
                    allocatableCapacityCredits: 0
            text/json:
              example:
                data:
                  capacityYearId: 0
                  tradingMonth: string
                  participantId: string
                  ircr: 0
                  allocatableCapacityCredits: 0
                  facilityAllocatableCapacityCredits:
                  - sourceFacilityId: string
                    allocatableCapacityCredits: 0
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/Window/{tradingDay}:
    get:
      operationId: retrievesTheCapacityCreditAllocationWindowForATradingDay
      summary: Retrieves the capacity credit allocation window for a trading day
      tags:
      - RCM Operations
      description: "This method returns the Capacity Credit Allocation Window for a trading day in which\
        \ participants may submit or withdraw a capacity credit allocation submission.\r\n<br /><br />\r\
        \nNote: This method is only available from Capacity Year 2023 (with the implementation of WEM\
        \ Reform).\r\n<br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer available.\r\
        \n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          capacity credit allocation submission e.g. 2023-10-01
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  tradingDay: string
                  ccaWindowOpen: string
                  ccaWindowClose: string
            text/json:
              example:
                data:
                  tradingDay: string
                  ccaWindowOpen: string
                  ccaWindowClose: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/window/{tradingDay}:
    get:
      operationId: retrievesTheCCAWindowForATradingDay
      summary: Retrieves the CCA Window for a Trading Day.
      tags:
      - RCM Operations
      description: "This method returns the Capacity Credit Allocation Window for a Trading Day in which\
        \ Market Participants may submit or withdraw Capacity Credit Allocation Submission.\r\n<br /><br\
        \ />\r\nNote: This method is only available from Capacity Year 2026."
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day associated with the
          request (Format: YYYY-MM-DD, e.g. 2026-10-01)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  tradingDay: string
                  ccaWindowOpen: string
                  ccaWindowClose: string
            text/json:
              example:
                transactionId: {}
                data:
                  tradingDay: string
                  ccaWindowOpen: string
                  ccaWindowClose: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocations:
    get:
      operationId: retrievesTheCompleteListOfCapacityCreditAllocationsForTheCapacityYear
      summary: Retrieves the complete list of Capacity Credit Allocations for the Capacity Year
      tags:
      - RCM Operations
      description: "This method returns all allocations made (if participant is a Market Generator), all\
        \ allocations received (if participant is a Market Customer), or both (if participant is both\
        \ a Market Generator and a Market Customer) for the specified Capacity Year.\r\n<br /><br />\r\
        \nNote: From Trading Month June 2019 (with the implementation of Rule Change RC_2017_06), this\
        \ method will not return any information as it has been removed.\r\n<br />\r\nNote: From Capacity\
        \ Year 2023 onwards, this API is no longer available."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityAllocations/{tradingMonth}:
    get:
      operationId: retrievesTheCompleteListOfCapacityCreditAllocationsForTheCapacityYearAndTradingMonth
      summary: Retrieves the complete list of Capacity Credit Allocations for the Capacity Year and Trading
        Month
      tags:
      - RCM Operations
      description: "This method returns a list of all Capacity Credit Allocations made by a Participant,\
        \ all Capacity Credit\r\nAllocations received (if the Participant is a Market Customer), or both\
        \ (if the Participant is both a\r\nMarket Generator and a Market Customer) and the corresponding\
        \ Facility from which the Capacity Credit\r\nAllocation was made for the specified Capacity Year\
        \ and Trading Month.\r\n<br /><br />\r\nNote: This method is only available from Trading Month\
        \ June 2019 (with the implementation of Rule Change RC_2017_06).\r\n<br />\r\nNote: From Capacity\
        \ Year 2023 onwards, this API is no longer available.\r\n<br />\r\nThe sourceFacilityId field\
        \ is only available for Capacity Allocations for Trading Month October 2021\r\nonwards arising\
        \ from the Wholesale Electricity Market Amendment(Reserve Capacity Pricing Reforms) Rules 2019.\r\
        \nFor calls for TradingMonth before October 2021 the fields “sourceFacilityId” and “subStatus”\
        \ will return values\r\nif available else it will return \"\". The response field “sourceFacilityId”\
        \ will return \"\" for TradingMonth\r\nbefore October 2021."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2017)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The trading month for the allocation (format: "MMM" eg:''OCT'', ''AUG'')'
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v2/CapacityYears/{capacityYearId}/CapacityAllocations/{tradingMonth}/{facilityId}:
    get:
      operationId: retrievesTheCompleteListOfCapacityCreditAllocationsForTheCapacityYearTradingMonthAndFacilityId
      summary: Retrieves the complete list of Capacity Credit Allocations for the Capacity Year, Trading
        Month and FacilityId
      tags:
      - RCM Operations
      description: "This method returns all Capacity Credit Allocations made from the specified Facility.\r\
        \n<br /><br />\r\nNote: This method is only available from Trading Month October 2021 (with the\
        \ implementation of Rule Change RC_2019). \r\n<br />\r\nNote: From Capacity Year 2023 onwards,\
        \ this API is no longer available."
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year id (e.g. 2021)
      - name: tradingMonth
        in: path
        required: true
        schema:
          type: string
        description: 'The calendar month for the allocation (format: "MMM" eg:''OCT'', ''AUG'')'
      - name: facilityId
        in: path
        required: true
        schema:
          type: string
        description: ID of the source facility
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
            text/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  capacityCreditsOffered: 0
                  capacityCreditsAccepted: 0
                  targetParticipantId: string
                  targetParticipantName: string
                  sourceParticipantId: string
                  sourceParticipantName: string
                  sourceFacilityId: string
                  status: string
                  subStatus: string
                  tradingMonth: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}:
    get:
      operationId: retrievesTheInformationForASpecificCapacityYear
      summary: Retrieves the information for a specific capacity year
      tags:
      - RCM Operations
      description: This contains the capacity year configuration parameters and important dates for the
        specified capacity year
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The ID of the capacity year to retrieve (eg 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: 0
                  dsmReserveCapacityPrice: 0
                  reserveCapacityPrice: 0
                  transitionalReserveCapacityPrice: 0
                  capacityYearStart: string
                  capacityYearEnd: string
                  eoiStart: string
                  eoiEnd: string
                  certStart: string
                  certEnd: string
                  certPublishAssignedCrc: string
                  rcSecurityStart: string
                  rcSecurityEnd: string
                  tradeDeclarationStart: string
                  tradeDeclarationEnd: string
                  tradeDeclarationCcPublication: string
                  dspVerificationStart: string
                  dspVerificationEnd: string
                  rcTestingSummerStart: string
                  rcTestingSummerEnd: string
                  rcTestingWinterStart: string
                  rcTestingWinterEnd: string
                  ntdlOctoberDeadline: string
                  ntdlNovemberDeadline: string
                  ntdlDecemberDeadline: string
                  ntdlJanuaryDeadline: string
                  ntdlFebruaryDeadline: string
                  ntdlMarchDeadline: string
                  ntdlAprilDeadline: string
                  ntdlMayDeadline: string
                  ntdlJuneDeadline: string
                  ntdlJulyDeadline: string
                  ntdlAugustDeadline: string
                  ntdlSeptemberDeadline: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears:
    get:
      operationId: retrievesTheInformationForAllCapacityYearCyclesConfiguredInTheRCMSystem
      summary: Retrieves the information for all capacity year cycles configured in the RCM system
      tags:
      - RCM Operations
      description: This is the full list of configuration parameters and important dates for all capacity
        years that have been configured in RCM
      parameters:
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                - id: 0
                  dsmReserveCapacityPrice: 0
                  reserveCapacityPrice: 0
                  transitionalReserveCapacityPrice: 0
                  capacityYearStart: string
                  capacityYearEnd: string
                  eoiStart: string
                  eoiEnd: string
                  certStart: string
                  certEnd: string
                  certPublishAssignedCrc: string
                  rcSecurityStart: string
                  rcSecurityEnd: string
                  tradeDeclarationStart: string
                  tradeDeclarationEnd: string
                  tradeDeclarationCcPublication: string
                  dspVerificationStart: string
                  dspVerificationEnd: string
                  rcTestingSummerStart: string
                  rcTestingSummerEnd: string
                  rcTestingWinterStart: string
                  rcTestingWinterEnd: string
                  ntdlOctoberDeadline: string
                  ntdlNovemberDeadline: string
                  ntdlDecemberDeadline: string
                  ntdlJanuaryDeadline: string
                  ntdlFebruaryDeadline: string
                  ntdlMarchDeadline: string
                  ntdlAprilDeadline: string
                  ntdlMayDeadline: string
                  ntdlJuneDeadline: string
                  ntdlJulyDeadline: string
                  ntdlAugustDeadline: string
                  ntdlSeptemberDeadline: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/CapacityYearsWithFacilityPrice:
    get:
      operationId: retrievesTheInformationForAllCapacityYearCyclesConfiguredInTheRCMSystem2
      summary: Retrieves the information for all capacity year cycles configured in the RCM system
      tags:
      - RCM Operations
      description: This is the full list of configuration parameters and important dates for all capacity
        years that have been configured in RCM
      parameters:
      - name: participantId
        in: query
        required: false
        schema:
          type: string
      - name: showUnpublished
        in: query
        required: false
        schema:
          type: boolean
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                - id: 0
                  reserveCapacityPrice: 0
                  dsmReserveCapacityPrice: 0
                  appendix3AssignedCredits: 0
                  reserveCapacityRequirement: 0
                  benchmarkReserveCapacityPrice: 0
                  rcrAvailabiltyClass1: 0
                  rcrAvailabiltyClass2: 0
                  benchmarkPriceFactor: 0
                  dsmActivationPrice: 0
                  expectedDsmDispatchQuantity: 0
                  peakDemandForecast: 0
                  publishRcp: true
                  publishDsmRcp: true
                  capacityYearStart: string
                  capacityYearEnd: string
                  facilityPrices:
                  - facilityId: string
                    price: 0
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityCredits/History:
    get:
      operationId: retrievesTheListOfCapacityCreditsForAllParticipants
      summary: Retrieves the list of capacity credits for all participants
      tags:
      - RCM Operations
      description: Shows the historical Capacity Credits for all Facilities from Market Participants for
        the given Capacity Year. Note this report includes any previous changes to Capacity Credits up
        to and including today
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. ID of the capacity year to query (eg 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  participants:
                  - participantId: string
                    facilities:
                    - facilityId: string
                      capacityCredits:
                      - from: string
                        amount: 0
            text/json:
              example:
                data:
                  participants:
                  - participantId: string
                    facilities:
                    - facilityId: string
                      capacityCredits:
                      - from: string
                        amount: 0
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/CapacityCredits:
    get:
      operationId: retrievesTheListOfCapacityCreditsForTheParticipant
      summary: Retrieves the list of capacity credits for the participant
      tags:
      - RCM Operations
      description: Shows the historic view of the capacity credits for all facilities for the given capacity
        year
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. ID of the capacity year to query (eg 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  participants:
                  - participantId: string
                    facilities:
                    - facilityId: string
                      facilityType: string
                      indicativeFacilityClass: string
                      capacityCredits:
                      - effective:
                          from: string
                          to: string
                        comment: string
                        amount: 0
                        dspQuantity: 0
                        participantReduction: true
            text/json:
              example:
                data:
                  participants:
                  - participantId: string
                    facilities:
                    - facilityId: string
                      facilityType: string
                      indicativeFacilityClass: string
                      capacityCredits:
                      - effective:
                          from: string
                          to: string
                        comment: string
                        amount: 0
                        dspQuantity: 0
                        participantReduction: true
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/TwelvePeaks/Published:
    get:
      operationId: retrievesTheListOfPublished12PeakSWISTradingIntervals
      summary: Retrieves the list of published 12 Peak SWIS Trading Intervals
      tags:
      - RCM Operations
      description: This retrieves the full list of Published 12 Peak SWIS Trading Intervals since Market
        Start
      parameters:
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - capacityYearId: 0
                  interval: string
            text/json:
              example:
                data:
                - capacityYearId: 0
                  interval: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/FourPeaks/Published:
    get:
      operationId: retrievesTheListOfPublished4PeakSWISTradingIntervals
      summary: Retrieves the list of published 4 Peak SWIS Trading Intervals
      tags:
      - RCM Operations
      description: This retrieves the full list of Published 4 Peak SWIS Trading Intervals since Market
        Start
      parameters:
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - tradingMonthStart: string
                  interval: string
            text/json:
              example:
                data:
                - tradingMonthStart: string
                  interval: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/RCOQ:
    get:
      operationId: retrievesTheListOfRCOQsForASpecifiedTimeRange
      summary: Retrieves the list of RCOQs for a specified time range
      tags:
      - RCM Operations
      description: This retrieves the full list of Reserve Capacity Obligation Quantities for each facility
        for the provided time period, as calculated by MR 4.12. The from and to date values must be specified
        as query parameters
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The start of the interval being queried,
          for example 2017-01-01T08:00
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The end of the interval being queried,
          for example 2017-01-02T08:00
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                - facilityId: string
                  rcoq:
                  - value: 0
                    effective:
                      from: string
                      to: string
            text/json:
              example:
                data:
                - facilityId: string
                  rcoq:
                  - value: 0
                    effective:
                      from: string
                      to: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: Client Error
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/Rcoq/Components/DispatchInterval/{tradingDay}:
    get:
      operationId: retrievesTheListOfRCOQsForComponentsAtTradingIntervalForTheSpecifiedTradingDay
      summary: Retrieves the list of RCOQs for components at trading interval for the specified trading
        day
      tags:
      - RCM Operations
      description: Retrieves the list of RCOQs for components at trading interval for the specified trading
        day
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339).
      - name: participantId
        in: query
        required: false
        schema:
          type: string
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  separatelyCertifiedComponents:
                  - sccCode: string
                    rcoq:
                    - value: 0
                      effective:
                        from: string
                        to: string
            text/json:
              example:
                data:
                  separatelyCertifiedComponents:
                  - sccCode: string
                    rcoq:
                    - value: 0
                      effective:
                        from: string
                        to: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: Client Error
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/Rcoq/Facilities/TradingInterval/{tradingDay}:
    get:
      operationId: retrievesTheListOfRCOQsForFacilitiesAtTradingIntervalForTheSpecifiedTradingDay
      summary: Retrieves the list of RCOQs for facilities at trading interval for the specified trading
        day
      tags:
      - RCM Operations
      description: Retrieves the list of RCOQs for facilities at trading interval for the specified trading
        day
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339).
      - name: participantId
        in: query
        required: false
        schema:
          type: string
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    rcoq:
                    - value: 0
                      effective:
                        from: string
                        to: string
            text/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    rcoq:
                    - value: 0
                      effective:
                        from: string
                        to: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: Client Error
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/Esroi/TradingInterval/{tradingDay}:
    get:
      operationId: retrievesTheTradingDaysOnWhichESROIIsApplicableForTheCapacityYearForTheGivenDate
      summary: Retrieves the trading days on which ESROI is applicable for the capacity year for the given
        date
      tags:
      - RCM Operations
      description: This method returns the trading days for which esroi data based on the date variable
        only.eg. 10/01/2018 --> trading day 10/01/2018.
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). requested date in YYYY-MM-DD format
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  tradingDayIntervalRanges:
                  - firstIntervalStart: string
                    lastIntervalStart: string
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/CapacityCreditsWithComponents/{tradingDay}:
    get:
      operationId: showsTheViewOfTheCapacityCreditsForAllFacilitiesAndComponentsForAGivenTradingDayFromCapacityYears2023Onward
      summary: Shows the view of the capacity credits for all facilities and components for a given Trading
        Day from Capacity Years 2023 onward
      tags:
      - RCM Operations
      description: Shows the view of the capacity credits for all facilities and components for a given
        Trading Day from Capacity Years 2023 onward
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339).
      - name: participantId
        in: query
        required: false
        schema:
          type: string
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    indicativeFacilityClass: string
                    associatedCapacityCredits: 0
                    associatedEsrCapacityCredits: 0
                    associatedIgsCapacityCredits: 0
                    associatedNigsCapacityCredits: 0
            text/json:
              example:
                data:
                  facilities:
                  - facilityId: string
                    indicativeFacilityClass: string
                    associatedCapacityCredits: 0
                    associatedEsrCapacityCredits: 0
                    associatedIgsCapacityCredits: 0
                    associatedNigsCapacityCredits: 0
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/flexible/{tradingDay}/submit:
    post:
      operationId: submitsAFlexibleCCASubmissionInRespectOfAFacilityOrSCCForATradingDayWhenTheCCAWindowIsOpen
      summary: Submits a Flexible CCA Submission in respect of a Facility or SCC for a Trading Day, when
        the CCA Window is open.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to submit a Flexible Capacity Credit Allocation\
        \ Submission in respect of a Facility or SCC for a Trading Day within the Capacity Year, when\
        \ the window is open.\r\n<br /><br />\r\nNote: This method is only available from Capacity Year\
        \ 2027."
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day associated with the
          request (Format: YYYY-MM-DD, e.g. 2027-10-01)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      requestBody:
        content:
          application/json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
          text/json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
          application/*+json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              flexibleCapacityCredits: 0
        description: JSON object containing the details to submit the allocation
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  entityCode: string
                  entityType: string
                  targetParticipantCode: string
                  flexibleCapacityCredits: 0
                  status: string
            text/json:
              example:
                transactionId: {}
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  entityCode: string
                  entityType: string
                  targetParticipantCode: string
                  flexibleCapacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/peak/{tradingDay}/submit:
    post:
      operationId: submitsAPeakCCASubmissionInRespectOfAFacilityOrSCCForATradingDayWhenTheCCAWindowIsOpen
      summary: Submits a Peak CCA Submission in respect of a Facility or SCC for a Trading Day, when the
        CCA Window is open.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to submit a Peak Capacity Credit Allocation\
        \ Submission in respect of a Facility or SCC for a Trading Day within the Capacity Year, when\
        \ the window is open.\r\n<br /><br />\r\nNote: This method is only available from Capacity Year\
        \ 2026."
      parameters:
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: 'Format - date-time (as date-time in RFC3339). The Trading Day associated with the
          request (Format: YYYY-MM-DD, e.g. 2026-10-01)'
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      requestBody:
        content:
          application/json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
          text/json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
          application/*+json:
            example:
              entityCode: string
              entityType: string
              targetParticipantCode: string
              peakCapacityCredits: 0
        description: JSON object containing the details to submit the allocation
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  entityCode: string
                  entityType: string
                  targetParticipantCode: string
                  peakCapacityCredits: 0
                  status: string
            text/json:
              example:
                transactionId: {}
                data:
                  id: 0
                  capacityYear: 0
                  tradingDay: string
                  participantCode: string
                  entityCode: string
                  entityType: string
                  targetParticipantCode: string
                  peakCapacityCredits: 0
                  status: string
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v1/CapacityYears/{capacityYearId}/Facilities:
    get:
      operationId: theSummaryOfFacilitiesForAGivenCapacityYearForTheParticipant
      summary: The summary of facilities for a given capacity year for the participant
      tags:
      - RCM Operations
      description: This provides a summary of all of the facilities for the participant for the given
        capacity year, showing the same information as the Market Participant dashboard in RCM
      parameters:
      - name: capacityYearId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The ID of the capacity year (eg 2017)
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                - id: 0
                  capacityYearId: 0
                  participantId: string
                  facilityId: string
                  facilityType: string
                  facilityStatus: string
                  availabilityClass: string
                  assignedCrc: 0
                  tradedCrc: 0
                  assignedCapacityCredits: 0
                  capacityCredits: 0
                  relevantDemand: 0
                  relevantDemandUsedSubstituteValues: true
                  requiredLevel: 0
                  excludedFromCapacityYear: true
                  isNewFacility: true
                  isEarlyEntry: true
                  dspQuantity: 0
                  businessDayDispatchStart: string
                  businessDayDispatchEnd: string
                  nonBusinessDayDispatchStart: string
                  nonBusinessDayDispatchEnd: string
                  nonBusinessDayDispatchSaturday: true
                  nonBusinessDayDispatchSunday: true
                  nonBusinessDayDispatchPublicHoliday: true
                  primaryFuelType: string
                  alternateFuelType: string
                  certifiedFuelType: string
                  lastObligationDateChange:
                    changeComment: string
                    changeDate: string
                  facilityObligationDate: string
                  facilityProposedOn: string
                  facilityCommittedOn: string
                  facilityCommercialOperationOn: string
                  facilityDecommissionedOn: string
                  upgrades:
                  - name: string
                    assignedCapacityCredits: 0
                    certifiedIn: string
                    upgradeCapacityYearId: 0
                    upgradeStatus: string
                    proposedOn: string
                    committedOn: string
                    commercialOperationOn: string
                    decommissionedOn: string
                    obligationDate: string
                  ownerships:
                  - participantId: string
                    participantName: string
                    dateFrom: string
                    dateTo: string
                  transfers:
                  - from: string
                    to: string
                    date: string
                  asAt: string
                  initialRequiredLevel: 0
                  priceTypeName: string
                  priceTypeStartCapacityYearId: 0
                  priceTypeEndCapacityYearId: 0
                  typedReserveCapacityPrice: 0
                  facilityClassCode: string
                  hasNcess: true
                  highestNaq: 0
                  finalNaq: 0
                  indicativeNaq: 0
                  isEarlyCrc: true
                  preliminaryNaq: 0
                  isNaff: true
                  isGiaFacility: true
                  auditStartTime: string
                  auditEndTime: string
                  initialNaq: 0
                  hasNcsContract: true
                  maxHoursPerDay: 0
                  maxHoursPerYear: 0
                  minStableLevelFinal: 0
                  requiredSecurityAmount: 0
                  securityRequired: true
                  eoiSubmitted: true
                  earlyEntry: true
                  obligationDate: string
                  tradeSubmittedOn: string
                  facilityClass:
                    id: 0
                    name: string
                    code: string
                    description: string
                    isActive: true
                  facility:
                    id: string
                    type: string
                    status: string
                    proposedOn: string
                    committedOn: string
                    commercialOperationOn: string
                    decommissionedOn: string
                  capacityYearComponents:
                  - id: 0
                    capacityYearFacilityId: 0
                    capacityYearComponentId: 0
                    capacityYearComponentUpgradeId: 0
                    technologyTypeId: 0
                    technologyTypeName: string
                    technologyTypeCode: string
                    componentStatusEffectiveDate: string
                    name: string
                    assignedCrc: 0
                    tradedCrc: 0
                    certifiedFuelType: string
                    primaryFuelType: string
                    alternateFuelType: string
                    initialRequiredLevel: 0
                    relevantLevel: 0
                    isExisting: true
                    technologyType:
                      id: 0
                      name: string
                      code: string
                      description: string
                      facilityClassIds:
                      - 0
                    committedOn: string
                    commercialOperationOn: string
                    isUpgrade: true
                    isNaff: true
                    isNameplateIncrease: true
                    componentStatus: string
                    mergedOn: string
                    obligationDate: string
                    proposedOn: string
                    comment: string
                    assignedCapacityCredits: 0
                    certifiedIn: string
                    minCcq: 0
                  facilityStatusEffectiveDate: string
                  ccUplift: 0
                  preliminaryNaqPrevYear: 0
                  indicativeNaqPrevYear: 0
                  highestNaqPrevYear: 0
                  finalNaqPrevYear: 0
                  assignedCapacityCreditsPrevYear: 0
                  minCcq: 0
                  isFixedPriceCandidate: true
                  finalNaqPrevYears: true
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: ''
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v3/CapacityYears/{capacityYear}/CapacityAllocations/{tradingDay}/{ccaId}/withdraw:
    put:
      operationId: withdrawACapacityCreditAllocationSubmissionInRespectOfAFacilityForATradingDay
      summary: Withdraw a capacity credit allocation submission in respect of a facility for a trading
        day
      tags:
      - RCM Operations
      description: "This method allows a market participant to withdraw a Capacity Credit Allocation Submission\
        \ in respect of a facility for a trading day within the capacity year, when the window is open.\r\
        \n<br /><br />\r\nNote: This method is only available from Capacity Year 2023 (with the implementation\
        \ of WEM Reform).\r\n<br /><br />\r\nNote: From Capacity Year 2026 onwards, this API is no longer\
        \ available.\r\n<br />"
      parameters:
      - name: capacityYear
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The capacity year associated with the capacity credit allocation
          submission (e.g. 2023)
      - name: tradingDay
        in: path
        required: true
        schema:
          type: string
        description: Format - date-time (as date-time in RFC3339). The trading day associated with the
          capacity credit allocation submission e.g. 2023-10-01
      - name: ccaId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The id of the capacity credit allocation submission
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                statusCode: 0
            text/json:
              example:
                statusCode: 0
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                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: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
        '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: Client Error
        '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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/flexible/{ccaId}/withdraw:
    put:
      operationId: withdrawsAnApprovedFlexibleCCA
      summary: Withdraws an approved Flexible CCA.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to withdraw a Flexible Capacity Credit Allocation\
        \ Submission in respect of a Facility or SCC for a Trading Day within the Capacity Year, when\
        \ the window is open.\r\n<br></br>\r\nNote: This method is only available from Capacity Year 2027."
      parameters:
      - name: ccaId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The id of the Flexible Capacity Credit Allocation Submission
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data: {}
            text/json:
              example:
                transactionId: {}
                data: {}
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
  /api/v4/capacityCreditAllocations/peak/{ccaId}/withdraw:
    put:
      operationId: withdrawsAnApprovedPeakCCA
      summary: Withdraws an approved Peak CCA.
      tags:
      - RCM Operations
      description: "This method allows a Market Participant to withdraw a Peak Capacity Credit Allocation\
        \ Submission in respect of a Facility or SCC for a Trading Day within the Capacity Year, when\
        \ the window is open.\r\n<br></br>\r\nNote: This method is only available from Capacity Year 2026."
      parameters:
      - name: ccaId
        in: path
        required: true
        schema:
          type: integer
        description: Format - int32. The id of the Peak Capacity Credit Allocation Submission
      - name: X-transactionId
        in: header
        required: false
        schema:
          type: string
        description: The unique identifier for the request
      - name: x-initiatingParticipantId
        in: header
        required: true
        schema:
          type: string
        description: The id of the Initiating Participant
      - name: x-market
        in: header
        required: true
        schema:
          type: string
        description: The id of the market
      responses:
        '200':
          description: Success
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: {}
                data: {}
            text/json:
              example:
                transactionId: {}
                data: {}
        '400':
          description: Bad Request
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                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: ''
        '403':
          description: Forbidden
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
        '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: Client Error
          content:
            text/plain:
              example: ''
            application/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  title: string
                  detail: string
                  source: string
            text/json:
              example:
                transactionId: string
                data: {}
                errors:
                - code: 0
                  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: Application unavailable
          content:
            application/json:
              examples:
                applicationUnavailable:
                  summary: Application Unavailable
                  value: ''
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: RCM Operations
  description: RCM Operations