DigiOffice Gateway Web Services

<back to all web services

GenerateExcelDocument

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

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.DocumentGenerator.SDK.Operations.Excel
Imports IDB.DocumentGenerator.SDK.DTO.Excel

Namespace Global

    Namespace IDB.DocumentGenerator.SDK.DTO.Excel

        Public Partial Class GenerateExcelDocumentResponse
            Implements IGenerateExcelDocumentResponse
            '''<Summary>
            '''Contains the registration ID of the generated (corporate identity) document
            '''</Summary>
            <ApiMember(Description:="Contains the registration ID of the generated (corporate identity) document", IsRequired:=true)>
            Public Overridable Property DocumentID As Guid
        End Class
    End Namespace

    Namespace IDB.DocumentGenerator.SDK.Operations.Excel

        '''<Summary>
        '''Generate new or update a (corporate identity) document based on an existing document registration.
        '''</Summary>
        <Api(Description:="Generate new or update a (corporate identity) document based on an existing document registration.")>
        Public Partial Class GenerateExcelDocument
            Implements IGenerateExcelDocument
            '''<Summary>
            '''ID of the current document registration
            '''</Summary>
            <ApiMember(Description:="ID of the current document registration", IsRequired:=true)>
            Public Overridable Property RegisteredDocumentID As Guid

            '''<Summary>
            '''Recreate document
            '''</Summary>
            <ApiMember(Description:="Recreate document", IsRequired:=true)>
            Public Overridable Property RecreateDocument As Boolean

            '''<Summary>
            '''ID of the document generator configuration
            '''</Summary>
            <ApiMember(Description:="ID of the document generator configuration")>
            Public Overridable Property DocumentGeneratorDocumentID As Nullable(Of Guid)

            '''<Summary>
            '''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.
            '''</Summary>
            <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.")>
            Public Overridable Property DataSourceEntityID As String
        End Class
    End Namespace
End Namespace

VB.NET GenerateExcelDocument DTOs

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

HTTP + XML

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

POST /xml/reply/GenerateExcelDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateExcelDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Excel">
  <DataSourceEntityID>String</DataSourceEntityID>
  <DocumentGeneratorDocumentID>00000000-0000-0000-0000-000000000000</DocumentGeneratorDocumentID>
  <RecreateDocument>false</RecreateDocument>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
</GenerateExcelDocument>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateExcelDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Excel">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</GenerateExcelDocumentResponse>