Agent.Get

August 10, 2015

Description

Gets the Agent definition and meta data for an Agent.

Required parameters

AgentID

Returns

A response containing the AgentID, Name, CollectionID, Description, Domain, and Definition for an Agent.

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=Agent.Get&AgentID=1005

Example response

<?xml version="1.0" encoding="utf-8" ?>
<AgentGetResponse 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>  
	<AgentID>1005</AgentID>
	<Name>My First Agent</Name>
	<CollectionID>1005</CollectionID>
	<Description>Extracts new lead information</Description>
	<Domain>myleadwebsite.com</Domain>
	<Definition>
<![CDATA[<!-- Copyright (C) 2015 Mozenda, Inc. All rights reserved. -->

<Agent>
  <Version>1.0i</Version>
  <IeVersion>8.0</IeVersion>
  <AgentDefinition>

	 <!--- - - - - - - - Actions - - - - - - - - -->

	 <ActionList>

		<Action>
		  <ActionType>LoadPage</ActionType>
		  <Page>0</Page>
		  <DestinationPage>1</DestinationPage>
		  <TopLevelNav>True</TopLevelNav>
		  <TopLevelNavCount>1</TopLevelNavCount>
		  <PageUrl>http://www.mozenda.com/builderwelcome</PageUrl>
		</Action>

		<!-- Page 1 -->

		<Action>
		  <ActionType>PagePlaceHolder</ActionType>
		  <Page>1</Page>
		  <ItemType>PlaceHolder</ItemType>
		  <LoadUrl>http://www.mozenda.com/builderwelcome</LoadUrl>
		  <BaseUrl>http://www.mozenda.com/builderwelcome</BaseUrl>
		  <CaptureScreenShot>False</CaptureScreenShot>
		  <NonScrollingScreenShot>False</NonScrollingScreenShot>
		</Action>

		<Action>
		  <ActionType>BeginAnchorList</ActionType>
		  <Page>1</Page>
		  <ItemType>PlaceHolder</ItemType>
		  <ItemXPath>//div[1]/div[2]/div/div/h3[1]/a[1]</ItemXPath>
		  <ItemXPath>/html[1]/body[1]/div[1]/div[1]/div[2]/div/div/h3[1]/a[1]</ItemXPath>
		  <ListName>LeadNameList</ListName>
		</Action>

		<Action>
		  <ActionType>GetElementValue</ActionType>
		  <Description>Captures the text of the list item</Description>
		  <Page>1</Page>
		  <ItemType>PlaceHolder</ItemType>
		  <ItemXPath>.</ItemXPath>
		  <FieldExpression>%LeadName%</FieldExpression>
		</Action>

		<Action>
		  <ActionType>GetElementValue</ActionType>
		  <Page>1</Page>
		  <ItemType>PlaceHolder</ItemType>
		  <ItemXPath>../..</ItemXPath>
		  <FieldExpression>%ContactEmail%</FieldExpression>
		</Action>

		<Action>
		  <ActionType>EndList</ActionType>
		  <Page>1</Page>
		  <ListName>LeadNameList</ListName>
		</Action>

	 </ActionList>

  </AgentDefinition>
</Agent>]]>
</Definition>
	
</AgentGetResponse>

Need more information?

We'd love to hear from you.

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