DigiOffice Gateway Web Services

<back to all web services

GenerateWordDocument

Generate new or update a (corporate identity) document based on an existing document registration.

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GenerateWordDocumentResponse(IGenerateWordDocumentResponse):
    # @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
    document_i_d: Optional[str] = None
    """
    Contains the registration ID of the generated (corporate identity) document
    """


# @Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GenerateWordDocument(IGenerateWordDocument):
    """
    Generate new or update a (corporate identity) document based on an existing document registration.
    """

    # @ApiMember(Description="ID of the current document registration", IsRequired=true)
    registered_document_i_d: Optional[str] = None
    """
    ID of the current document registration
    """


    # @ApiMember(Description="Recreate document", IsRequired=true)
    recreate_document: bool = False
    """
    Recreate document
    """


    # @ApiMember(Description="ID of the document generator configuration")
    document_generator_document_i_d: Optional[str] = None
    """
    ID of the document generator configuration
    """


    # @ApiMember(Description="ID of the entity (corresponding to the entityType configured at the DocumentGeneratorDocument) to use as the datasource. Leave blank to fall back on the current document registration.")
    data_source_entity_i_d: Optional[str] = None
    """
    ID of the entity (corresponding to the entityType configured at the DocumentGeneratorDocument) to use as the datasource. Leave blank to fall back on the current document registration.
    """

Python GenerateWordDocument DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/GenerateWordDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecreateDocument: False,
	DocumentGeneratorDocumentID: 00000000-0000-0000-0000-000000000000,
	DataSourceEntityID: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}