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
import Foundation
import ServiceStack

/**
* Generate new or update a (corporate identity) document based on an existing document registration.
*/
// @Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")
public class GenerateExcelDocument : IGenerateExcelDocument, Codable
{
    /**
    * ID of the current document registration
    */
    // @ApiMember(Description="ID of the current document registration", IsRequired=true)
    public var registeredDocumentID:String?

    /**
    * Recreate document
    */
    // @ApiMember(Description="Recreate document", IsRequired=true)
    public var recreateDocument:Bool?

    /**
    * ID of the document generator configuration
    */
    // @ApiMember(Description="ID of the document generator configuration")
    public var documentGeneratorDocumentID:String?

    /**
    * 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.
    */
    // @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 var dataSourceEntityID:String?

    required public init(){}
}

public class GenerateExcelDocumentResponse : IGenerateExcelDocumentResponse, Codable
{
    /**
    * Contains the registration ID of the generated (corporate identity) document
    */
    // @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
    public var documentID:String?

    required public init(){}
}


Swift GenerateExcelDocument 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/GenerateExcelDocument 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

{
	
}