API.revise - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.revise

From Calaméo Knowledge Base

This action allows you to publish a new revision of a document.

<toc>

Request

The API key must have the publish access right.
Note: Requests must be multipart/form-data encoded and the endpoint must be http://upload.calameo.com/1.0
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
book_id yes string ID of the publication.
file yes file Document to be uploaded (like provided by a HTML form file field).
preserve boolean Keep links and table of contents from previous publication (default: 0=no).

Response

Returns a Publication.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      ID: ...,
      AccountID: ...,
      SubscriptionID: ...,
      Name: ...,
      Description: ...,
      Status: ...,
      IsPublished: ...,
      IsPrivate: ...,
      AuthID: ...,
      AllowMini: ...,
      Date: ...,
      Creation: ...,
      Modification: ...
    }
  }
}

Error codes

See the Error Codes.