get_pdf#

Subscription | API Key Required

Generates a full load zone PDF report over a WebSocket connection (GraphQL subscriptions via graphql-ws). The server streams progress updates; the final message contains the base64-encoded PDF and a suggested filename.

WebSocket Endpoint:

wss://api-gateway.dlubal.com/geo-zone/pub/graphql

from dlubal.api import geo_zone_tool

geo_zone = geo_zone_tool.GeoZoneTool("<your-token>")
for progress in geo_zone.get_load_zone_pdf(
    address="Munich, Germany",
    standard="EN 1991-1-3",
    annex="Germany",
    layer_id=1,
    language=geo_zone_tool.Language.EN,
):
    print(progress.current_step, "/", progress.steps)
    if progress.pdf_result:
        print(progress.pdf_result.name)
        break

using GeoZoneTool;
using GeoZoneTool.Models;

using var client = new GeoZone("your-token");

await foreach (var progress in client.GetLoadZonePdfAsync(
    new GetPdfRequest
    {
        Address = "Munich, Germany",
        Standard = "EN 1991-1-3",
        Annex = "Germany",
        LayerId = 1,
        Language = LanguageEnum.En
    }))
{
    Console.WriteLine($"Progress: {progress.CurrentStep}/{progress.Steps}");
    if (progress.PdfResult is not null) break;
}

subscription {
  getPdf(
    pdfInput: {
      address: "Munich, Germany"
      standard: "EN 1991-1-3"
      annex: "Germany"
      layerId: 1
    }
    language: EN
  ) {
    currentStep
    steps
    message
    pdfResult { pdf name }
  }
}

Input#

Parameter	Type	Required	Description
`address`	str	Yes	Free-text address or place name
`standard`	str	Yes	Standard name filter
`annex`	str	Yes	Annex filter
`layer_id`	int	Yes	Layer ID
`language`	Language	No	Response language (default EN)

Response#

Streams PdfProgressType messages. The final message includes pdf_result with the base64-encoded PDF and suggested filename.