Items: Document
This SOAP-based API is deprecated. Please use the REST-based API instead.
Document informations
| Name | Type | Description |
|---|---|---|
| Code | string | Unique identifying key for the publication (only needed for publication updates or revision). |
| CID | string | ID of the uploaded file (only needed for publication uploads, updates or revisions). |
| URL | string | URL of the file to convert (only needed for publication uploads, updates or revision from URLs) |
| Text | string | Text to convert into a publication (only needed for publication uploads, updates or revision from raw text) |
| Name | string | Publication title (if empty, filename will be used) |
| Description | string | Description of the publication. |
| CategoryReference (required) | string | Category reference. |
| FormatReference (required) | string | Format reference. |
| DialectReference (required) | string | Language reference. |
| PublishingMode (required) | integer | Access to the publication. Either 1 (public) or 2 (private). |
| IsPublished | boolean | Activation status. Either true or false. |
| PrivateUrlMode | boolean | Use a private URL. Either true or false. |
| SubscribingMode | boolean | Allow subscribers' access. Either true or false. |
| CommentingMode | integer | Comments behaviour. Either 0 (disabled), 1 (moderate all), 2 (moderate all except contacts), 3 (accept only contacts) or 4 (accept all). |
| DownloadingMode | integer | Download behaviour. Either 0 (disabled), 1 (only contacts) or 2 (everyone). |
| MiniMode | boolean | Allow MiniCalaméo. Either true or false. |
| AdultMode | boolean | Adult content. Either true or false. |
| ReadingMode | boolean | Reading direction. Either 0 (left-to-right) or 1 (right-to-left "manga mode"). |
| LicensingMode | string | License. Either <empty> (no license) or pd (public domain), by, by_nc, by_nc_nd, by_nc_sa, by_nd or by_sa (Creative Commons). |
| SkinUrl | string | Custom skin URL (see CSML documentation) |
| LogoUrl | string | Custom logo URL. |
| LogoLink | string | Custom logo link URL. |
| BackgroundURL | string | Custom background URL. |
| MusicUrl | string | Custom background music URL. |
| MusicMode | integer | Background music mode. Either 0 (loop forever), 1 (play only once). |
| SoundEffectMode | integer | Play sound effects like page flipping. Either true or false. |
| FlipSoundUrl | string | Custom page flipping sound URL. |
