Change Block order

Changed on

With this request you can create a new version of the block list. All provided blocks in payload will be active in the new version. All the active blocks from the previous block list version which are missing in the payload are cancelled. One block is identified by its name parameter value. To cancel all blocks send empty blocks array in payload.

patch/blockorders/{orderId}

Request

  • Base URL
    https://auctions-api.test.nordpoolgroup.com/api/v1
  • URL
    https://auctions-api.test.nordpoolgroup.com/api/v1/blockorders/{orderId}
  • Auth
    API key in header Authorization

Path parameters

orderIdstring required

Id of block order

Request body

commentstring

Free text to label an order. Max 255 characters long.

Response

200

OR

Example response

{
  "orderId": "00000000-0000-0000-0000-000000000000",
  "areaCode": "NL",
  "portfolio": "p1",
  "companyName": "Test Company",
  "auctionId": "XX_H_DA_1-20200122",
  "modifier": "auction.api@example.com",
  "modified": "2020-11-05T07:26:01.470Z",
  "currencyCode": "EUR",
  "blocks": [
    {
      "modifier": "auction.api@example.com",
      "state": "Accepted",
      "name": "RegularBlock86",
      "price": 17.9,
      "minimumAcceptanceRatio": 0.22,
      "periods": [
        {
          "contractId": "XX_H_DA_1-20200123-03"
        }
      ]
    }
  ]
}

Changes