Agent.GetCombinedCollections
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Agent.GetCombinedCollections

  • Dark
    Light
  • PDF

Article summary

Description

Returns a list of agents and the combined collections they source.

URL parameters

NameRequiredTypeDescription
AgentIDTruenumericUnique identifier of the agent. A comma-separated list.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.
AgentAgentAgent information.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetCombinedCollections&AgentID=1036,1037,1038"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<AgentGetCombinedCollectionsResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<AgentList>
		<Agent>           
			<AgentID>1001</AgentID>
			<SourcesCollections>1145</SourcesCollections>
			</Agent>
			<Agent>
			<AgentID>1002</AgentID>
			<SourcesCollections>1145,1146</SourcesCollections>
		</Agent>
	</AgentList>
</AgentGetCombinedCollectionsResponse>

JSON (add &ResponseFormat=JSON)

{
  "Agent": [
    {
      "AgentID": 1036,
      "SourcesCollections": ""
    },
    {
      "AgentID": 1037,
      "SourcesCollections": ""
    },
    {
      "AgentID": 1038,
      "SourcesCollections": ""
    }
  ],
  "JsonResult": {
    "Command": "Agent.GetCombinedCollections",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?

What's Next