Lokad API version 2 Web Service

Lokad API version 2

Click here for a complete list of operations.

GetTasks

Allows to page through the TaskInfo collections associated with the Lokad account

See M:Lokad.Api.IForecastApi.GetTasks in the Technical Documentation for more details.

Parameters:

identity - The identity that represents Lokad account to work with.
cursor - The cursor for paging (use for the first page and for all subsequent pages).
pageSize - Size of the page.

Returns: page that contains objects for the specified account (within 100 and 1000).

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Forecasting2.asmx HTTP/1.1
Host: sandbox-ws.lokad.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://lokad.com/ws_2/GetTasks"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTasks xmlns="http://lokad.com/ws_2/">
      <identity Username="string" Password="string" />
      <cursor>guid</cursor>
      <pageSize>int</pageSize>
    </GetTasks>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTasksResponse xmlns="http://lokad.com/ws_2/">
      <GetTasksResult Cursor="guid" ThereAreMorePages="boolean">
        <Tasks>
          <TaskInfo TaskID="guid" SerieID="guid" Period="None or QuarterHour or HalfHour or Hour or Day or Week or Month or Quarter or Semester or Year" PeriodStart="dateTime" FuturePeriods="int" />
          <TaskInfo TaskID="guid" SerieID="guid" Period="None or QuarterHour or HalfHour or Hour or Day or Week or Month or Quarter or Semester or Year" PeriodStart="dateTime" FuturePeriods="int" />
        </Tasks>
      </GetTasksResult>
    </GetTasksResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Forecasting2.asmx HTTP/1.1
Host: sandbox-ws.lokad.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTasks xmlns="http://lokad.com/ws_2/">
      <identity Username="string" Password="string" />
      <cursor>guid</cursor>
      <pageSize>int</pageSize>
    </GetTasks>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTasksResponse xmlns="http://lokad.com/ws_2/">
      <GetTasksResult Cursor="guid" ThereAreMorePages="boolean">
        <Tasks>
          <TaskInfo TaskID="guid" SerieID="guid" Period="None or QuarterHour or HalfHour or Hour or Day or Week or Month or Quarter or Semester or Year" PeriodStart="dateTime" FuturePeriods="int" />
          <TaskInfo TaskID="guid" SerieID="guid" Period="None or QuarterHour or HalfHour or Hour or Day or Week or Month or Quarter or Semester or Year" PeriodStart="dateTime" FuturePeriods="int" />
        </Tasks>
      </GetTasksResult>
    </GetTasksResponse>
  </soap12:Body>
</soap12:Envelope>