Operation getTaskStatus returns status of operation with taskId.

Some requests (ie. startLogin, startRegister, addSlaves, etc.) returns id of created task instead of direct answer. In such case status (and result) of task can be checked using getTaskStatus method. Usually result of task is stored in json in additionalInfo field.


Note: every task has its timeout, after exceeding it, task is removed from task queue, therefore getTaskStatus will return ERR_TASK_DOES_NOT_EXISTS.

Example SOAP request:

<soapenv:Envelope xmlns:xsi="" xmlns:xsd="" 
xmlns:soapenv="" xmlns:ns1="ns1">
      <ns1:getTaskStatus soapenv:encodingStyle="">
         <taskId xsi:type="xsd:string">7W3A0N1N9I2E7N1TKLS54A9PTR</taskId>


Example SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:SOAP-ENC="" 
xmlns:xsi="" xmlns:xsd="" xmlns:ns1="ns1">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="">
         <return xsi:type="ns1:vuiSoapGetTaskStatusResponse">
            <requestStatusDescription>Request succeeded.</requestStatusDescription>


Request parameters:

parameter type description
taskId string id of task
uniqueTransferId string transaction id
callback bool whether to send messages with task progress/status or not


Response parameters:

name type description
additionalInfo string additional info
status string task status
type string task type
progressPercent unsigned int progress percent
taskId string id of created task
requestStatus string result of request
requestStatusDescription string status description


Possible errors:

error description
ERR_INVALID_TASK_ID invalid task id
ERR_TASK_DOES_NOT_EXIST task with provided id does not exist
Was this article helpful to you? Yes No

How can we help?