Collection.GetFields

August 10, 2015

Description

Returns a list of fields that are in that collection with their details

Required parameters

CollectionID

Optional parameter

Include (Can be set to All or Unique. It defaults to All.)

Returns

A list of fields for a collection.

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=Collection.GetFields&CollectionID=1001&Include=Unique

Example response

<?xml version="1.0" encoding="utf-8" ?>
<CollectionGetFieldsResponse 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>
  <FieldList>
	 <Field>
		<FieldID>418</FieldID>
		<CollectionID>1003</CollectionID>
		<Name>ID</Name>
		<Description>Unique number identifying the Default.</Description>
		<IsSystem>True</IsSystem>
		<IsMatchUp>False</IsMatchUp>
	 </Field>
	 <Field>
		<FieldID>430</FieldID>
		<CollectionID>1003</CollectionID>
		<Name>AgentID</Name>
		<Description />
		<IsSystem>True</IsSystem>
		<IsMatchUp>False</IsMatchUp>
	 </Field>
  </FieldLists>
</CollectionGetFieldsResponse>