Generate grid-operator documents
POST/v1/offers/:id/network-carrier-documents
Fill the grid operator's (Netzbetreiber) registration forms for an offer and return them as a ZIP archive. The documents are rendered on demand from the offer's current technical data and are not stored, so each call produces a fresh archive.
Every field of the body is optional. With none of them, the operator set on the offer's project is used and all of its forms are produced — so POST with {} is the normal call. To pick specific forms, or an operator other than the project's, look them up with GET /v1/grid-operators; GET /v1/offers/{id}/network-carrier-documents/options resolves everything this offer can reference in one call.
This is a POST because the request carries a body, but it changes nothing. Requires the read:documents scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
A ZIP archive with one PDF per requested document, plus the merged PDF when asked for.
validation_error, network_carrier_not_set, no_documents_configured or unknown_document_ids
invalid_api_key
insufficient_scope
not_found
generation_failed