SOAP API Functions

All functions in the webservice are named with their identifier first. If you want to operate on a resource item, for example, youll take a look at the ResourceItemXXX functions. More specific functions (eg for documents) may be named with the name of the specific resource (eg: DocumentGetIpadXml).

Name	Description
AdsGetFromURL	Downloads an external XML file containing information on ads, and converts it for use in CHILI Editor
ApiKeyGetCurrentSettings	Return the current XML representation of the apiKey
ApiKeyKeepAlive	Call to keep the current apiKey alive (slide expiration back)
AssetGetImageInfo	Returns information about the underlying image
BarcodeCreate	Creates a barcode, or returns information on it if it already existed in the cache
BarcodeCreateColored	Creates a barcode, or returns information on it if it already existed in the cache.
CsvFileCreate	Converts an XML to CSV format, and returns a download link
DataSourceAddSampleFile	Adds a bew sample file to a DataSource
DataSourceDeleteSampleFile	Deletes a sample files assigned to a DataSource
DataSourceDownloadSpreadsheets	Downloads a list of spreadsheets for a datasource (if its type = 'google')
DataSourceDownloadURL	Returns the result of one of the external URLs for a DataSource
DataSourceFileGetXML	Converts an uploaded file to generic XML using the settings of a DataSource
DataSourceListSampleFiles	Get a list of the sample files assigned to a DataSource
DataSourceSalesForceGetXML	Downloads an XML representation of the selected salesforce Query
DataSourceSpreadsheetGetXML	Downloads an XML representation of the selected spreadsheet
DocumentCopyAnnotations	Duplicates annotations from one document to another
DocumentCopyDocumentEventActions	Duplicates Document Event Actions from one document to another
DocumentCopyVariableDefinitions	Duplicates variable definitions from one document to another
DocumentCreateFromBlankDocTemplate	Creates a new document based on the settings in the "DocumentTemplates" resource. This resource contains such settings as number of pages, dimensions, etc.
DocumentCreateFromChiliPackage	Creates a new document based on a zip file containing a CHILI package (usually generated by the InDesign Extension).
DocumentCreateFromPDF	Creates a new document based on a PDF file
DocumentCreateImages	Generates a zip containing images of all the pages in the document.
DocumentCreatePackage	Generates a CHILI Package of the document.
DocumentCreatePDF	Generates a PDF of the document.
DocumentCreateTempImages	Generates Images of all the pages in the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
DocumentCreateTempPackage	Generates a CHILI Package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
DocumentCreateTempPDF	Generates a PDF of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
DocumentGetAnnotations	Returns information on the annotations contained in a document
DocumentGetDefaultSettings	Returns default settings for an editor session. This function is used by CHILI Editor to retrieve a series of informations in one call.
DocumentGetDocumentEventActions	Returns the definitions of the Document Event Actions contained in a document
DocumentGetEditorURL	Returns a URL for editing (or viewing) of the specified document, with arguments to determine how the interface will be constructed
DocumentGetHTMLEditorURL	Returns a URL for editing (or viewing) of the specified document in the HTML editor, with arguments to determine how the interface will be constructed
DocumentGetHTMLFoldingViewerURL	Returns a URL for viewing of a document's Folding representation in the HTML edtior
DocumentGetInfo	Returns general information on a document in an XML format which is easier to parse than the full document XML.
DocumentGetIpadXML	Called by the iPad Reader to get a description of a document
DocumentGetPlacedAdsAndEdit	Returns information on the ads and edit contained in a document
DocumentGetPreflightResults	Returns information on the preflight results which were present in the document on the last save
DocumentGetUsedAssets	Returns information on the assets contained in a document
DocumentGetVariableDefinitions	Returns the definitions of the variables contained in a document
DocumentGetVariableValues	Returns the values of the variables contained in a document
DocumentSetAnnotations	Inserts annotations into a document
DocumentSetAssetDirectories	Save new Asset Directory locations (doc., user, user group) for the document. Empty strings will be ignored (so the existing value will be retained). To clear an asset directory, provide the string 'empty' as the argument
DocumentSetConstraints	Applies constraints to a document. The constraints are configured in the "DocumentConstraints" Resource (usually through the backoffice). These contain settings to configure naming conventions (and general settings) for the application of constraints. The naming conventions are used to update the document (you will see the constraints in the DocumentConstraints, Page Settings, Layer Settings and Frame Constraints panel items in CHILI Editor)
DocumentSetDocumentEventActions	Applies Document Event Action definitions to a document
DocumentSetVariableDefinitions	Applies variable definitions to a document
DocumentSetVariableValues	Sets the values of variables in a document
DownloadURL	Download a URL from the server. This function is used by CHILI Editor to prevent security issues (eg: crossdomain.xml files which aren't present on the target server)
EditsGetFromURL	Downloads an external XML file containing information on edits, and converts it for use in CHILI Editor
EnvironmentAdd	Creates a new environment, with the specified name
EnvironmentCopy	Copies an existing environment. A new environment is created and all files are copied
EnvironmentDelete	Deletes a complete environment, including it's files on disk
EnvironmentGetColorProfiles	Returns a list of the Color Profiles available for the environment.
EnvironmentGetCurrent	Returns a description of the current environment
EnvironmentGetDiskUsage	Provide a list of resources/folders, and have the same XML structure returned including the folder sizes
EnvironmentGetLoginSettings	Gets initial settings for the specified environment. This function is called before the user has logged in, so it does not require an API Key (and therefore also only returns the most basic information required for a login screen)
EnvironmentGetSettings	Returns the settings of the specified environment
EnvironmentList	Returns a list of available environments for the current user
EnvironmentSaveSettings	Saves the settings of an environment
FontGetIncludedGlyphs	Returns an XML document containing ranges of glyphs (and their availibility) in the font
GenerateApiKey	Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments
GenerateApiKeyWithSettings	Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments
GetServerDate	Returns the date of the server
HealthCheckExecute	Executes a Health Check, and returns an XML string with the found warnings/errors
IconSetAddIcon	Ads an icon (png) to an IconSet Resource Item
IconSetDeleteIcon	Removes an icon from an IconSet Resurce Item
IconSetGetIcons	Describes the icons which are present in an Icon Set (and optionally also includes all non-present icon definitions)
InterfaceGetInitialSettings	Function used by CHILI Editor to retrieve a number of settings of the current Environment in one call.
LanguageGetCombinedStrings	Get the (combined) strings for a Language. This includes the values of the parent language for non-translated strings.
LanguageGetCsvURL	Returns a urlInfo XML for the CSV file of the language (which is created on the fly)
LanguageGetUnicodeTextURL	Returns a urlInfo XML for the txt file (tab-delimited) of the language (which is created on the fly)
LanguageImportCsv	Uploads a CSV file (of the same format as exported using LanguageGetCsvURL) and imports it into a language. Strings outside of the 'Custom' section are not created, only updated.
LanguageImportUnicodeText	Uploads a txt file (tab-delimited, of the same format as exported using LanguageGetUnicodeTextURL) and imports it into a language. Strings outside of the 'Custom' section are not created, only updated.
LanguageSaveStrings	Saves the string library for a language