Get Projects

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

Request

URL	https://vorexlogin.com/GetProjects

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	clients	string
PARAM	startDateFrom	dateTime
PARAM	startDateTo	dateTime
PARAM	dueDateFrom	dateTime
PARAM	dueDateTo	dateTime
PARAM	departments	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 projects based on. For multiple clients you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
startDateFrom - Specify the earliest project start date. If Null this will be ignored.
startDateTo - Specify the latest project start date. If Null this will be ignored.
dueDateFrom - Specify the earliest project due date. If Null this will be ignored.
dueDateTo - Specify the latest project due date. If Null this will be ignored.
departments - Specify the department(s) value(s) by which to filter projects based on. For multiple departments 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 projects 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/GetProjects"

<?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>
    <GetProjects xmlns="https://vorexlogin.com/">
      <clients>string</clients>
      <startDateFrom>dateTime</startDateFrom>
      <startDateTo>dateTime</startDateTo>
      <dueDateFrom>dateTime</dueDateFrom>
      <dueDateTo>dateTime</dueDateTo>
      <departments>string</departments>
      <statuses>string</statuses>
    </GetProjects>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetProjectsResult:

Array of api_ProjectListingResult:
- pkProjectId (int)
- ClientName (string)
- ProjectNumber (string)
- ProjectName (string)
- ProjectCode (string)
- ContractName (string)
- Manager (string)
- ProjectStatus(string)
- StartDate (dateTime)
- DueDate (dateTime)
- Completion (dateTime)
- PlannedHours (decimal)
- UsedHours (decimal)
- PlannedBudget (decimal)
- ActualBudget (decimal)

outputMessage:

Empty String

Failure

GetProjectsResult:

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>
    <GetProjectsResponse xmlns="https://vorexlogin.com/">
      <GetProjectsResult>
        <api_ProjectListingResult>
          <ClientName>string</ClientName>
          <ProjectNumber>string</ProjectNumber>
          <ProjectName>string</ProjectName>
          <ProjectCode>string</ProjectCode>
          <ContractName>string</ContractName>
          <Manager>string</Manager>
          <ProjectStatus>string</ProjectStatus>
          <StartDate>dateTime</StartDate>
          <DueDate>dateTime</DueDate>
          <Completion>dateTime</Completion>
          <PlannedHours>decimal</PlannedHours>
          <UsedHours>decimal</UsedHours>
          <PlannedBudget>decimal</PlannedBudget>
          <ActualBudget>decimal</ActualBudget>
          <pkProjectId>int</pkProjectId>
        </api_ProjectListingResult>
      </GetProjectsResult>
      <outputMessage>string</outputMessage>
    </GetProjectsResponse>
  </soap:Body>
</soap:Envelope>