Get Tasks

Returns an api_TaskListingResult array of your project tasks defined in your Vorex account, with the ability to filter by clients, dates, projects, and status.

Request

URL	https://vorexlogin.com/GetTasks

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	clients	string
PARAM	startDateFrom	dateTime
PARAM	startDateTo	dateTime
PARAM	endDateFrom	dateTime
PARAM	endDateTo	dateTime
PARAM	projects	string
PARAM	statuses	string
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
clients - Specify the clients(s) value(s) by which to filter tasks based on. For multiple clients you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
startDateFrom - Specify the earliest task start date. If Null this will be ignored.
startDateTo - Specify the latest task start date. If Null this will be ignored.
endDateFrom - Specify the earliest task end date. If Null this will be ignored.
endDateTo - Specify the latest task end date. If Null this will be ignored.
projects - Specify the project(s) value(s) by which to filter tasks based on. For multiple projects you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
statuses - Specify the project status(s) value(s) by which to filter tasks based on. For multiple statuses you have to separate by Comma (,). If Null or Empty ("") this will be ignored.

Example Request

POST /WS/OpenAPI.asmx HTTP/1.1
Host: vorexlogin.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://vorexlogin.com/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:Header>
    <WSUserCredentials xmlns="https://vorexlogin.com/">
      <UserName>string</UserName>
      <Password>string</Password>
      <CompanyName>string</CompanyName>
    </WSUserCredentials>
  </soap:Header>
  <soap:Body>
    <GetTasks xmlns="https://vorexlogin.com/">
      <clients>string</clients>
      <startDateFrom>dateTime</startDateFrom>
      <startDateTo>dateTime</startDateTo>
      <endDateFrom>dateTime</endDateFrom>
      <endDateTo>dateTime</endDateTo>
      <projects>string</projects>
      <statuses>string</statuses>
    </GetTasks>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetTasksResult:

Array of api_TaskListingResult:
- pkTaskId (int)
- ParentTaskId (int)
- ClientName (string)
- ProjectName (string)
- TaskStatus (string)
- StartDate (dateTime)
- EndDate (dateTime)
- UsedHours (decimal)
- PercentageUsed (decimal)
- EstimatedHours (decimal)
- TaskType (string)

outputMessage:

Empty String

Failure

GetTasksResult:

Returns Null

outputMessage:

"An Error has Occurred while processing the request."

Example Response

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="https://vorexlogin.com/">
      <GetTasksResult>
        <api_TaskListingResult>
          <TaskName>string</TaskName>
          <ProjectName>string</ProjectName>
          <ClientName>string</ClientName>
          <TaskStatus>string</TaskStatus>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <UsedHours>decimal</UsedHours>
          <PercentUsed>decimal</PercentUsed>
          <EstimatedHours>decimal</EstimatedHours>
          <TaskType>string</TaskType>
          <pkTaskId>int</pkTaskId>
          <ParentTaskId>int</ParentTaskId>
        </api_TaskListingResult>
      </GetTasksResult>
      <outputMessage>string</outputMessage>
    </GetTasksResponse>
  </soap:Body>
</soap:Envelope>