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

Agent.GetMoveCopyStatus

  • Dark
    Light
  • PDF

Article summary

Gets the status of the API call on the copied/moved agent.

URL parameters

NameRequiredTypeDescription
BatchIDTruenumericUnique identifier used to monitor the progress of the Agent.Copy and Agent.MoveGet request.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.
StatestringDone if the operation was completed.
Error MessagestringReturns a description of what the error is when the job errors.
Error CodestringIt returns a shorter version description of what the error is when the** job** errors.
ProgressstringShows the progress of the copying/moving process.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX -XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetMoveCopyStatus&BatchID=32557"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<GetMoveCopyStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>
  <State>Done</State>
  <ErrorMessage />
  <ErrorCode />
  <Progress />
</GetMoveCopyStatusResponse>

JSON (add &ResponseFormat=JSON)

{
   "State": "Done",
   "ErrorMessage": "",
   "ErrorCode": "",
   "Progress": "",
   "JsonResult": {
      "Command": "Agent.GetMoveCopyStatus",
      "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