Collection.Publish

August 10, 2015

Description

Publishes the collection according to the publishing information setup for the collection. Currently, this can be entered via the Web Console or using the
Collection.SetPublisher call. For more information about configuring your collection for FTP publishing please click here.

Required parameters

CollectionID

Optional Parameters

Job.StatusUrl – A url that Mozenda will request when the job finishes processing.
The url needs to begin with either the http:// or https:// protocol and needs to be url encoded.
It can contain any of the following replacement values anywhere in the querystring. To include a replacement value enclose it in percentage signs (e.g. %JobID%).

JobID
Job.Status
Job.Created
Job.Ended

Note: The status url may be requested multiple time for the Running status.

Returns

The result of the operation and the jobID if the request was successful.

Example request url

https://api.mozenda.com/rest?WebServiceKey=3FE7221C-9097-4B64-AED6-0950F675F398&Service=Mozenda10&Operation=Collection.Publish&CollectionID=1005

Example response

<?xml version="1.0" encoding="utf-8" ?>
<CollectionPublishResponse
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>  
  <JobID>EE64EC0E-F233-4549-8DF0-852298965F81</JobID>
 </CollectionPublishResponse>