1. Wstęp
  2. Corporate Node
  3. Operacje SOAP
  4. getTaskStatus

getTaskStatus

Operacja getTaskStatus zwraca status operacji o podanym taskId.

Dla wielu zapytań (np. startLogin, startRegister, addSlaves, itp) nie jest zwracana odpowiedź tylko identyfikator utworzonego zadania.
W takim przypadku status (ewentualnie wynik) zadania może być sprawdzony za pomocą metody getTaskStatus.
Zwykle informacja zwrotna jest w formie json w polu additionalInfo.

Uwaga: zadania zwykle są pamiętane przez pewien czas od utworzenia. Po przekroczeniu tego czasu zapytanie getTaskStatus
zwróci odpowiedź ERR_TASK_DOES_NOT_EXISTS.

Przykładowe zapytanie SOAP:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="ns1">
   <soapenv:Header/>
   <soapenv:Body>
      <ns1:getTaskStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <taskId xsi:type="xsd:string">7W3A0N1N9I2E7N1TKLS54A9PTR</taskId>
      </ns1:getTaskStatus>
   </soapenv:Body>
</soapenv:Envelope>

Przykładowa odpowiedź SOAP:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ns1">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <ns1:getTaskStatusResponse>
         <return xsi:type="ns1:vuiSoapGetTaskStatusResponse">
            <requestStatus>SUCCESS</requestStatus>
            <requestStatusDescription>Request succeeded.</requestStatusDescription>
            <taskId>7W3A0N1N9I2E7N1TKLS54A9PTR</taskId>
            <type>REGISTER</type>
            <progressPercent>0</progressPercent>
            <status>PREPARATION</status>
            <additionalInfo>{
}</additionalInfo>
         </return>
      </ns1:getTaskStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parametry zapytania:

parametr typ opis
callback bool czy wysyłać kolejne wiadomości o statusie zadania
uniqueTransferId string identyfikator transakcji
taskId string identyfikator zadania

Parametry odpowiedzi:

nazwa typ opis
additionalInfo string dodatkowe informacje
status string status zadania
progressPercent unsigned int procent postępu
type string typ zadania
taskId string id powstałego taska
requestStatusDescription string opis statusu
requestStatus string status wykonania zapytania

Możliwe błędy:

błąd opis
ERR_INVALID_TASK_ID nieprawidłowy identyfikator zadaniainvalid task id
ERR_TASK_DOES_NOT_EXIST task o takim id już nie istniejetask with provided id does not exist
Czy ten artykuł jest dla Ciebie pomocny? Tak Nie

Jak możemy pomóc?