View.GetItems

August 10, 2015

Description

Returns items from a view.
To learn how to setup a view for a collection click here.

Required parameters

ViewID

Conditional parameters

CollectionID – Required if the view is a shared view in an agent group.

Optional parameters

ItemStatusIncludeColumn (‘Yes’, ‘No’ – Yes to include the column in the data file. Default is No)
PageNumber
PageItemCount
ViewParameter.JobID
ViewParameter.<ViewParameterName>

Optional parameters for ItemStatusInclude

ItemStatusIncludeAdded (‘Yes’, ‘No’)
ItemStatusIncludeChanged (‘Yes’, ‘No’)
ItemStatusIncludeUnchanged (‘Yes’, ‘No’)
ItemStatusIncludeDeleted (‘Yes’, ‘No’)
ItemStatusRangeStart (YYYY-MM-DD HH:mm:ss – The beginning date to calculate the items that should be included with the view.)
ItemStatusRangeEnd (YYYY-MM-DD HH:mm:ss – The ending date to calculate the items that should be included with the view.)
ItemStatusIncludeChangeMarkup (‘Yes’, ‘No’)
Note: These item status filtering options have no effect unless ItemStatusIncludeColumn is true. See the Additional Information section below for usage.

Returns

The number of items that were requested according to the PageItemCount parameter
Note: A maximum of 1,000 items will be returned even if the specified PageItemCount parameter is greater than 1,000.

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=View.GetItems&ViewID=1022&ViewParameter.JobID=04E2DA-DF22-4239-A343-DE685AF54EC6&PageNumber=1&PageItemCount=20&ViewParameter.Name=Michael

Example response

<?xml version="1.0" encoding="utf-8" ?>
<ViewGetItemsResponse
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<PageItemCount>2</PageItemCount>
	<PageNumber>2</PageNumber>
	<PageCount>106</PageCount>
	<ItemList>
		<Item>
			<ItemID>1092</ItemID>
			<Year>2000</Year>
			<Make>BMW</Make>
			<Model>328CI</Model>
			<Price>$7490</Price>
			<Telephone>4049141131</Telephone>
			<AreaCode>404</AreaCode>
			<Source>A1Cars</Source>
		</Item>
		<Item>
			<ItemID>1103</ItemID>
			<Year>2003</Year>
			<Make>BMW</Make>
			<Model>525i</Model>
			<Price>$14850</Price>
			<Telephone>8606342015</Telephone>
			<AreaCode>860</AreaCode>
			<Source>A1Cars</Source>
		</Item>
	</ItemList>
</ViewGetItemsResponse>

Additional Information

ItemStatusInclude options

  • If any item status filtering options are set to true, the results will only include items with those statuses.
  • If no item status filtering option is set to true, and any are set to false, the results will include items with all statuses not set to false.
  • Finally, if no item status filtering options are set at all, the results will include items with statuses of Added, Changed, and UnChanged, but not Deleted.

ItemStatusRange options

  • If the ItemStatusRangeStart and ItemStatusRangeEnd values are not provided, the system uses the start and end times of the supplied JobID.
  • If no JobID is supplied, the system will get this range from the most recently created job for this Agent.

Need more information?

We'd love to hear from you.

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