Post Submit Schedules
curl --request POST \
--url https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"executed_epex_volume": [
123
]
}
'import requests
url = "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules"
payload = { "executed_epex_volume": [123] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({executed_epex_volume: [123]})
};
fetch('https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'executed_epex_volume' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules"
payload := strings.NewReader("{\n \"executed_epex_volume\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"executed_epex_volume\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"executed_epex_volume\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"delivery_day": "2023-12-25",
"schedules": [
{
"components": [
{
"kind": "<string>",
"direction": "<string>",
"values": [
123
]
}
],
"balance": [
123
]
}
],
"balanced": true,
"submission_accepted": true,
"submission_reference": "<string>",
"imbalances": [
{}
],
"submission_detail": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}API Reference
Post Submit Schedules
Build the balancing-group schedules and submit them to Engrate.
POST
/
v1
/
process
/
delivery-days
/
{delivery_day}
/
submit-schedules
Post Submit Schedules
curl --request POST \
--url https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"executed_epex_volume": [
123
]
}
'import requests
url = "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules"
payload = { "executed_epex_volume": [123] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({executed_epex_volume: [123]})
};
fetch('https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'executed_epex_volume' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules"
payload := strings.NewReader("{\n \"executed_epex_volume\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"executed_epex_volume\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-service-host}/v1/process/delivery-days/{delivery_day}/submit-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"executed_epex_volume\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"delivery_day": "2023-12-25",
"schedules": [
{
"components": [
{
"kind": "<string>",
"direction": "<string>",
"values": [
123
]
}
],
"balance": [
123
]
}
],
"balanced": true,
"submission_accepted": true,
"submission_reference": "<string>",
"imbalances": [
{}
],
"submission_detail": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Body
application/json
Input for the schedule submission step (scope: process).
executed_epex_volume defaults to the requested total open position;
pass the real EPEX fills to reflect actual execution.
Response
Successful Response
The four German TSO control areas (Regelzonen).
Available options:
50Hertz, Amprion, TenneT, TransnetBW Show child attributes
Show child attributes
Residual per (area, interval) where a group does not net to zero
Per-TSO result from the scheduling platform, including the rejection reason when a submission was not accepted
⌘I