DigiOffice Gateway Web Services

GenerateWordPrintableDocument

Generate a (corporate identity) printable document based on an existing document registration or working file.

The following routes are available for this service:
All Verbs	/api/documentgenerator/word/generateprintabledocument

**GenerateWordPrintableDocument** Parameters:
Name	Parameter	Data Type	Required	Description
RegisteredDocumentID	query	Guid	Yes	ID of the current document registration
WorkingFile	query	DocumentBase64File	No	The unsaved active document to print instead of the saved document.
LogoStyle	query	PrintLogoStyle	No	When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document
PageSetup	query	WordPageSetup	No	Represents a subset of the page setup properties of a section.

**DocumentBase64File** Parameters:
Name	Parameter	Data Type	Required	Description
ContentType	form	string	No
Content	form	string	No

**PrintLogoStyle** Enum:
Colour
Invisible

**WordPageSetup** Parameters:
Name	Parameter	Data Type	Required	Description
FirstPageTray	form	int	No
OtherPagesTray	form	int	No

**GenerateWordPrintableDocumentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
File	form	DocumentBase64File	No	The file to print

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 /api/documentgenerator/word/generateprintabledocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateWordPrintableDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
  <LogoStyle>Colour</LogoStyle>
  <PageSetup xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
    <d2p1:FirstPageTray>0</d2p1:FirstPageTray>
    <d2p1:OtherPagesTray>0</d2p1:OtherPagesTray>
  </PageSetup>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
  <WorkingFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </WorkingFile>
</GenerateWordPrintableDocument>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateWordPrintableDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </File>
</GenerateWordPrintableDocumentResponse>