DigiOffice Gateway Web Services

<back to all web services

GenerateWordPrintableDocument

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

Requires Authentication
The following routes are available for this service:
All Verbs/api/documentgenerator/word/generateprintabledocument
GenerateWordPrintableDocument Parameters:
NameParameterData TypeRequiredDescription
RegisteredDocumentIDqueryGuidYesID of the current document registration
WorkingFilequeryDocumentBase64FileNoThe unsaved active document to print instead of the saved document.
LogoStylequeryPrintLogoStyleNoWhen printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document
PageSetupqueryWordPageSetupNoRepresents a subset of the page setup properties of a section.
DocumentBase64File Parameters:
NameParameterData TypeRequiredDescription
ContentTypeformstringNo
ContentformstringNo
WordPageSetup Parameters:
NameParameterData TypeRequiredDescription
FirstPageTrayformintNo
OtherPagesTrayformintNo
GenerateWordPrintableDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
FileformDocumentBase64FileNoThe file to print

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"__type":"IDB.DocumentGenerator.SDK.Operations.Word.GenerateWordPrintableDocument, IDB.DocumentGenerator.SDK","RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","WorkingFile":{"__type":"IDB.DocumentGenerator.SDK.DTO.DocumentBase64File, IDB.DocumentGenerator.SDK","ContentType":"String","Content":"String"},"LogoStyle":"Colour","PageSetup":{"__type":"IDB.DocumentGenerator.SDK.DTO.Word.WordPageSetup, IDB.DocumentGenerator.SDK","FirstPageTray":0,"OtherPagesTray":0}}

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

{"__type":"IDB.DocumentGenerator.SDK.DTO.Word.GenerateWordPrintableDocumentResponse, IDB.DocumentGenerator.SDK","File":{"__type":"IDB.DocumentGenerator.SDK.DTO.DocumentBase64File, IDB.DocumentGenerator.SDK","ContentType":"String","Content":"String"}}