Skip to main content

reviseFromUrl

This action allows you to publish a new revision of document from a file available on the internet.

info

The API key must have access rights to publish.

Request​

NameTypeDescription
apikeyRequiredstringAPI public key
signatureRequiredstringSignature of the request.
expirestimestampUNIX timestamp for request expiration (GMT)
outputstringFormat of the response. Either XML (default), JSON or PHP
book_idRequiredstringID of the publication
urlRequiredstringURL of the document to publish
subscription_idRequiredintegerID of the folder

Response​

This method returns a Publication.

NameTypeDescription
IDstringID of the publication
AccountIDintegerPublication's owner account ID (should be your account ID)
SubscriptionIDintegerPublication's owner subscription ID
DescriptionstringDescription of the publication
StatusstringConversion status of the publication. Either QUEUE (waiting to be converted), PROCESS (processing document), STORE (converting document), ERROR (error during conversion) or DONE (publication ready)
IsPublishedintegerSends 1 if the publication is published and 0 if not
IsPrivateintegerSends 1 if the publication is private and 0 if not
AuthIDstringAuthentication parameter for private URLs (authid)
AllowMiniintegerSends 1 if the publication allows access to the miniCalaméo and 0 if not
PagesintegerNumber of pages of the publication
WidthintegerWidth of a page of the publication
HeightintegerHeight of a page of the publication
ViewsintegerNumber of views of the publication
DownloadsintegerNumber of downloads of the publication
CommentsintegerNumber of comments of the publication
FavoritesintegerNumber of favorites from the publication
DatedateReference date of the publication
CreationdatetimeDate of creation of the publication
PublicationdatetimeScheduled date of the publication (UTC)
ModificationdatetimeDate of the last modification of the publication
PosterUrlstringAbsolute URL for the publication's larger cover
PictureUrlstringAbsolute URL for the publication's cover
ThumbUrlstringAbsolute URL for the publication's thumbnail
PublicUrlstringAbsolute URL for the publication's overview
ViewUrlstringAbsolute URL for the publication's reading page
CommentsUrlstringAbsolute URL for the publication's comments

Example response​

JSON
{
"response": {
"status": "ok",
"version": 2,
"requestid": "TrRptA",
"requests": 227,
"content": {
"ID": "004516825ca65f113d232",
"SubscriptionID": 4540112,
"AccountID": 4516825,
"Name": "Test",
"Description": "1",
"Category": "MISC",
"Format": "MISC",
"Dialect": "de",
"Status": "REQUEUE",
"IsPublished": 1,
"IsPrivate": 1,
"AuthID": "nl85OHvgXeKP",
"AllowMini": 1,
"Date": "2015-10-16",
"Pages": 0,
"Width": 0,
"Height": 0,
"Views": 0,
"Downloads": 0,
"Comments": 0,
"Favorites": 0,
"PosterUrl": "",
"PictureUrl": "",
"ThumbUrl": "",
"PublicUrl": "",
"ViewUrl": "",
"Creation": "2015-10-16 11:31:58",
"Modification": "2015-10-16 11:31:58"
}
}
}