Information Classification: External Restricted.
See https://www.chili-publish.com/security
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 |
---|---|
Downloads an external XML file containing information on ads, and converts it for use in CHILI Editor | |
Return the current XML representation of the apiKey | |
Call to keep the current apiKey alive (slide expiration back) | |
Returns information about the underlying image | |
Creates a barcode, or returns information on it if it already existed in the cache | |
Creates a barcode, or returns information on it if it already existed in the cache. | |
Converts an XML to CSV format, and returns a download link | |
Adds a bew sample file to a DataSource | |
Deletes a sample files assigned to a DataSource | |
Downloads a list of spreadsheets for a datasource (if its type = 'google') | |
Returns the result of one of the external URLs for a DataSource | |
Converts an uploaded file to generic XML using the settings of a DataSource | |
Get a list of the sample files assigned to a DataSource | |
Downloads an XML representation of the selected salesforce Query | |
Downloads an XML representation of the selected spreadsheet | |
Duplicates annotations from one document to another | |
Duplicates Document Event Actions from one document to another | |
Duplicates variable definitions from one document to another | |
Creates a new document based on the settings in the "DocumentTemplates" resource. This resource contains such settings as number of pages, dimensions, etc. | |
Creates a new document based on a zip file containing a CHILI package (usually generated by the InDesign Extension). | |
Creates a new document based on a PDF file | |
Generates a zip containing images of all the pages in the document. | |
Generates a CHILI Package of the document. | |
Generates a PDF of the document. | |
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) | |
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) | |
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) | |
Returns information on the annotations contained in a document | |
Returns default settings for an editor session. This function is used by CHILI Editor to retrieve a series of informations in one call. | |
Returns the definitions of the Document Event Actions contained in a document | |
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 |
Returns general information on a document in an XML format which is easier to parse than the full document XML. | |
Called by the iPad Reader to get a description of a document | |
Returns information on the ads and edit contained in a document | |
Returns information on the preflight results which were present in the document on the last save | |
Returns information on the assets contained in a document | |
Returns the definitions of the variables contained in a document | |
Returns the values of the variables contained in a document | |
Inserts annotations into a document | |
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 | |
Applies constraints to a document. | |
Applies Document Event Action definitions to a document | |
Applies variable definitions to a document | |
Sets the values of variables in a document | |
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) | |
Downloads an external XML file containing information on edits, and converts it for use in CHILI Editor | |
Creates a new environment, with the specified name | |
Copies an existing environment. A new environment is created and all files are copied | |
Deletes a complete environment, including it's files on disk | |
Returns a list of the Color Profiles available for the environment. | |
Returns a description of the current environment | |
Provide a list of resources/folders, and have the same XML structure returned including the folder sizes | |
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) | |
Returns the settings of the specified environment | |
Returns a list of available environments for the current user | |
Saves the settings of an environment | |
Returns an XML document containing ranges of glyphs (and their availibility) in the font | |
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 | |
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 | |
Returns the date of the server | |
Executes a Health Check, and returns an XML string with the found warnings/errors | |
Ads an icon (png) to an IconSet Resource Item | |
Removes an icon from an IconSet Resurce Item | |
Describes the icons which are present in an Icon Set (and optionally also includes all non-present icon definitions) | |
Function used by CHILI Editor to retrieve a number of settings of the current Environment in one call. | |
Get the (combined) strings for a Language. This includes the values of the parent language for non-translated strings. | |
Returns a urlInfo XML for the CSV file of the language (which is created on the fly) | |
Returns a urlInfo XML for the txt file (tab-delimited) of the language (which is created on the fly) | |
Uploads a CSV file (of the same format as exported using LanguageGetCsvURL) and imports it into a language. | |
Uploads a txt file (tab-delimited, of the same format as exported using LanguageGetUnicodeTextURL) and imports it into a language. | |
Saves the string library for a language | |