eDocBuilder Template Manager Web Services API

EDOCBUILDER > Integration

METHODS

getAssets

Public Function getAssets(userEmail As String, userPassword As String, docCode As String, docPassword As String) As assetInfo() 

Summary:

Get the list of available assets(master pdf, fonts, graphics, image pickers, inDesign Document backgrounds)

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

Return a list of assets.

 

Remarks:

Eliminate preview from list if file has no extension or contain invalid extension.

 

getDocumentLibraryAssets

Public Function getDocumentLibraryAssets(userEmail As String, userPassword As String, docCode As String, docPassword As String) As assetInfo()
 

Summary:

Get the list of selected library assets in an account.(Library fonts and library images)

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

List of available library assets in an account.

 

Remarks:

Retrieve a list of selected library assets, generate file preview, and eliminate preview from list if file has no extension or contain invalid extension.

getFields

Public Function getFields(userEmail As String, userPassword As String, docCode As String, docPassword As String) As eDocLibrary.eDocFieldInfo()
 

Summary:

It will return all the fields in a template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

All the fields from a template.

 

Remarks:

Retrieve and process all the fields in a template.

getResponseSets

Public Function getResponseSets(userEmail As String, userPassword As String, docCode As String, docPassword As String) As eDocLibrary.responseSet() 
 

Summary:

It will return a predefined sets of responses for field entries that are common to specific theme, location or category.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

All the response set from the current template.

 

Remarks:

Response sets are not available for use in interactive Designer templates.


getTemplate

Public Function getTemplate(userEmail As String, userPassword As String, docCode As String, docPassword As String) As libraryTemplate
 

Summary:

It will retrieve the current template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

Template information including document width, document height, page count, bleed, category for document etc.

 

Remarks:

setAssets

Public Function setAssets(userEmail As String, userPassword As String, docCode As String, docPassword As String, assets() As assetInfo) As assetInfo()
 

Summary:

Set assets for a template (master pdf, fonts, graphics, image pickers, inDesign Document, backgrounds)

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

assets: Information about assets(asset url, assets name, assets type)

 

Return Values:

Return a list of assets.

 

Remarks:

The setAssets method will create/update preview or generate thumbnail of the assets(master pdf, fonts, graphics, image pickers, inDesign Document, backgrounds) and delete invalid assets from the folder.

 

setDocumentLibraryAssets

Public Function setDocumentLibraryAssets(userEmail As String, userPassword As String, docCode As String, docPassword As String, assets() As assetInfo) As assetInfo()
 

Summary:

Set the list of available library assets in an account. (Library fonts and library images)

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

assets: Information about assets(asset url, assets name, assets type)

 

Return Values:

List of available library assets in an account.

 

Remarks:

This method will create/update preview or generate thumbnail of the library assets (font, images),

delete invalid library assets (font, images) from the folder.

 

setFields

Public Function setFields(userEmail As String, userPassword As String, docCode As String, docPassword As String, docFields() As eDocLibrary.eDocFieldInfo, deleteOthers As Boolean) As eDocLibrary.eDocFieldInfo()
 

Summary:

It will set the fields for a template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

docFields(): Information about an eDoc field.

deleteOthers: if template field is delete keep it in active

 

Return Values:

All the fields for a template.

 

Remarks:

Create the field previews and check for valid fields. And if any template has no field available, it will create a dummy field, set default field lockdown if field lockdown is not initialized for any field and normalize the z-order of the field.

setResponseSets

Public Function setResponseSets(userEmail As String, userPassword As String, docCode As String, docPassword As String, responseSets() As eDocLibrary.responseSet) As eDocLibrary.responseSet()
 

Summary:

It will set all the response sets in a template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

responseSets(): Collection of predefined values for the fields in a template.

 

Return Values:

All the response set from the current template.

 

Remarks:

Create/update/delete response set, check whether to exclude any field when filling the response set.

 

setTemplate

Public Function setTemplate(userEmail As String, userPassword As String, docCode As String, docPassword As String, templateInfo As libraryTemplate) As libraryTemplate 

Summary:

It will set up the current template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

templateInfo:  Library template information.

 

Return Values:

The current template.

 

Remarks:

The setTemplate method will help you to create/update/delete the template information.

 

getLogicGroups

Public Function getLogicGroups(userEmail As String, userPassword As String, docCode As String, docPassword As String) As logicGroup()

 

Summary:

Iit will retrieve current logic sets.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

 

Return Values:

Current logic sets.

 

Remarks:

 

setLogicGroups

Public Function setLogicGroups(userEmail As String, userPassword As String, docCode As String, docPassword As String, logicGroups() As logicGroup) As logicGroup()

 

Summary:

It will set logic groups.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

logicGroups: set logic groups.

 

Return Values:

Return logic sets.

 

Remarks:

 

setTemplateEverything

 
Public Function setTemplateEverything(userEmail As String, userPassword As String, docCode As String, docPassword As String, templateInfo As libraryTemplate, fields() As eDocLibrary.eDocFieldInfo, assets() As assetInfo, responseSets() As eDocLibrary.responseSet) As libraryTemplate
 

Summary:

It will set everything in a template including assets, fields, template, response sets, logic group etc.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

templatInfo: Library template information.

fields: Information about an eDoc field.

assets: Information about assets(asset url, assets name, assets type).

responseSets: Collection of predefined values for the fields in a template.

 

Return Values:

Template informations

 

Remarks:

The same as executing setTemplate, setFields, setAssets and setResponseSets all in one call.

 

commitTemplate

 
Public Function commitTemplate(userEmail As String, userPassword As String, docCode As String, docPassword As String) As libraryTemplate 
 

Summary:

It will update the client info structure and updates the template preview image.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

 

Return Values:

Retrieve template informations.

 

Remarks:

Prepares the template for final use (it builds some XML fields, saves preview images, etc.)

 

prepareNonprintableArea

 
Public Function prepareNonprintableArea(userEmail As String, userPassword As String, docCode As String, docPassword As String) As Boolean Implements 
 

Summary:

It will prepare non printable area in a template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password.

 

Return Values:

Return true if non printable area is prepared else return false.

 

Remarks:

The prepareNonPrintableArea method will just fill the rectangle if there's no file, otherwise import the image, ignore rotation of fields, set field position etc.

 

getColorPalettes

 
Function getColorPalettes(userEmail As String, userPassword As String) As colorPalette() 
 

Summary:

It will get all the color palettes in a company .

 

Parameters:

userEmail: The company email.

userPassword: The company password.

 

Return Values:

Return  all the color palettes.

 

Remarks:

This method will retrieve all the color palettes in a company that you can selectively utilize throughout your templates. Note that your palette can have a mixture of CMYK, spot and RGB color.

 

addOrUpdateColorPalette

 
Public Function addOrUpdateColorPalette(userEmail As String, userPassword As String, paletteInformation As colorPalette) As colorPalette

Summary:

It will add or update color palette in a company.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

paletteInformation: the information about the palette

 

Return Values:

Return palette data i.e. paletteId, palette name, palette data,palette code..

 

Remarks:

 

removeUnusedFonts

 
Public Function removeUnusedFonts(username As String, password As String, docCode As String, docPassword As String, includeAllLibFonts As Boolean) As Integer
 

Summary:

It will remove all the unused font in a template.

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

includeAllLibFonts: include all library font


Return Values:

fonts count.

 

Remarks:


getUsedFonts

 
Public Function getUsedFonts(username As String, password As String, docCode As String, docPassword As String) As List(Of String) 
 

Summary:

It will verify which fonts are being used by a template

 

Parameters:

userEmail: The company email.

userPassword: The company password.

docCode: GUID for the document code

docPassword: GUID for the document password

 

Return Values:

Used font lists.

 

Remarks: