| POST | /api/documentgenerator/word/generateprintabledocument |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.DocumentGenerator.SDK.Operations.Word
Imports IDB.DocumentGenerator.SDK.DTO
Imports IDB.DocumentGenerator.SDK.DTO.Word
Namespace Global
Namespace IDB.DocumentGenerator.SDK.DTO
Public Partial Class DocumentBase64File
Public Overridable Property ContentType As String
Public Overridable Property Content As String
End Class
Public Enum PrintLogoStyle
Colour
Invisible
End Enum
End Namespace
Namespace IDB.DocumentGenerator.SDK.DTO.Word
Public Partial Class GenerateWordPrintableDocumentResponse
Implements IGenerateDraftDocumentResponse
'''<Summary>
'''The file to print
'''</Summary>
<ApiMember(Description:="The file to print")>
Public Overridable Property File As DocumentBase64File
End Class
Public Partial Class WordPageSetup
Public Overridable Property FirstPageTray As Integer
Public Overridable Property OtherPagesTray As Integer
End Class
End Namespace
Namespace IDB.DocumentGenerator.SDK.Operations.Word
'''<Summary>
'''Generate a (corporate identity) printable document based on an existing document registration or working file.
'''</Summary>
<Api(Description:="Generate a (corporate identity) printable document based on an existing document registration or working file.")>
Public Partial Class GenerateWordPrintableDocument
Implements IRegisteredDocumentRequest
'''<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>
'''The unsaved active document to print instead of the saved document.
'''</Summary>
<ApiMember(Description:="The unsaved active document to print instead of the saved document.")>
Public Overridable Property WorkingFile As DocumentBase64File
'''<Summary>
'''When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document
'''</Summary>
<ApiMember(Description:="When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document")>
Public Overridable Property LogoStyle As PrintLogoStyle
'''<Summary>
'''Represents a subset of the page setup properties of a section.
'''</Summary>
<ApiMember(Description:="Represents a subset of the page setup properties of a section.")>
Public Overridable Property PageSetup As WordPageSetup
End Class
End Namespace
End Namespace
VB.NET GenerateWordPrintableDocument DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","WorkingFile":{"ContentType":"String","Content":"String"},"LogoStyle":"Colour","PageSetup":{"FirstPageTray":0,"OtherPagesTray":0}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"File":{"ContentType":"String","Content":"String"}}