Generate grid-operator documents
POST/v1/offers/:id/network-carrier-documents
Fills in the grid operator's (Netzbetreiber) registration forms for an offer and returns 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: the body is not valid. network_carrier_not_set: the project has no grid operator; send networkCarrierId or set one on the project. no_documents_configured: the grid operator has no forms set up. unknown_document_ids: a documentIds entry is not one of the operator's forms; message lists the valid ones.
missing_api_key or invalid_api_key: no API key was sent, or it is wrong, expired or revoked.
insufficient_scope: the API key does not have the scope this endpoint needs. required names it.
not_found: there is no such record in your company.
generation_failed: the documents could not be produced; message has the details.