Collection.GetPublisher

August 10, 2015

Description

Returns a list of collections and their current publishing configuration.
Note: The PublishWhenAgentCompletes field will be removed if the collection is publishing on a schedule.

Required parameters

CollectionID or AgentID (comma separated lists)

Returns

A list of collections with their current publishing configuration.

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=Collection.GetPublisher&CollectionID=1099&AgentID=1002

Example response

<?xml version="1.0" encoding="utf-8" ?>
<GetPublisherResponse 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <Result>Success</Result>
 <CollectionList>
  <Collection>
	<CollectionName>Lowes</CollectionName>
	<CollectionID>1099</CollectionID>
	<AgentID>1001</AgentID>
	<PublishWhenAgentCompletes>1001</PublishWhenAgentCompletes>
	<Created>2012-01-01 10:50:45</Created>
	<CreatedBy>John</CreatedBy>
	<Description>Collection for Lowes</Description>
	<ViewID>1036</ViewID>
	<FileFormat>CSV</FileFormat>
	<FileName />
	<Method>Ftp</Method>   
	<IncludePackages>Yes</IncludePackages>	   
	<FtpServer>test.myserver.com</FtpServer>
	<FtpPort>21</FtpPort>
	<FtpDirectory />
	<FtpUser />
	<FtpPassword />
	<FtpUsePassive>Yes</FtpUsePassive>
	<FtpProtocol>SFTP</FtpProtocol>
  </Collection>
  <Collection>
	<CollectionName>DataCompare</CollectionName>
	<CollectionID>1025</CollectionID>
	<AgentID>1017</AgentID>
	<PublishWhenAgentCompletes>Yes</PublishWhenAgentCompletes>
	<Created>2017-11-15 20:23:28</Created>
	<CreatedBy>John</CreatedBy>
	<Description />
	<ViewID>1031</ViewID>
	<BookmarkID>0</BookmarkID>
	<FileFormat>TSV</FileFormat>
	<FileName />
	<FileIncludeHeader>True</FileIncludeHeader>
	<Method>Email</Method>
	<ItemStatusIncludeColumn>True</ItemStatusIncludeColumn>
	<ItemStatusIncludeAdded>True</ItemStatusIncludeAdded>
	<ItemStatusIncludeChanged>True</ItemStatusIncludeChanged>
	<ItemStatusIncludeChangeMarkup>True</ItemStatusIncludeChangeMarkup>
	<ItemStatusIncludeUnchanged>True</ItemStatusIncludeUnchanged>
	<ItemStatusIncludeRemoved>False</ItemStatusIncludeRemoved>
	<SearchText />
	<SearchField />
	<EmailAddress>john.doe@gmail.com</EmailAddress>
	<EmailSubject />
   </Collection>
 </CollectionList>  
</GetPublisherResponse>

Need more information?

We'd love to hear from you.

100% Privacy. You are that important to us. Privacy Policy