Get Time Sheets

Returns an api_GetTimeSheetsResult array of time entries and related information based on a date range, projects, clients and or usernames of employees.

Request

URL	https://vorexlogin.com/GetTimeSheets

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	dateFrom	dateTime
PARAM	dateTo	dateTime
PARAM	clientNames	string
PARAM	userNames	string
PARAM	projectNames	string
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
clientNames - Specify the clients(s) value(s) by which to filter time logs based on. For multiple clients you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
dateFrom - Specify the earliest time entry date. If Null this will be ignored.
dateTo - Specify the latest time entry date. If Null this will be ignored.
userNames - Specify the employee username(s) value(s) by which to filter time logs based on. For multiple usernames you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
projectNames - Specify the project(s) value(s) by which to filter time logs based on. For multiple usernames 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/GetTimeSheets"

<?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>
    <GetTimeSheets xmlns="https://vorexlogin.com/">
      <dateFrom>dateTime</dateFrom>
      <dateTo>dateTime</dateTo>
      <clientNames>string</clientNames>
      <userNames>string</userNames>
      <projectNames>string</projectNames>
    </GetTimeSheets>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetTimeSheetsResult:

Array of api_GetTimeSheetsResult:
- pkTimeEntryId (int)
- TimesheetId (int)
- UserName(string)
- Client (string)
- Source(string)
- Title (string)
- StartDate(dateTime)
- TimeSpent (decimal)
- Billable (int)
- RoleName (string)
- RoleRate (decimal)
- WorkTypName (string)
- Notes (string)
- Billed (boolean)
- IsPosted (boolean)

outputMessage:

Empty String

Failure

GetTimeSheetsResult:

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>
    <GetTimeSheetsResponse xmlns="https://vorexlogin.com/">
      <GetTimeSheetsResult>
        <api_GetTimeSheetsResult>
          <pkTimeEntryId>int</pkTimeEntryId>
          <TimesheetId>int</TimesheetId>
          <UserName>string</UserName>
          <Client>string</Client>
          <Source>string</Source>
          <title>string</title>
          <StartDate>dateTime</StartDate>
          <TimeSpent>decimal</TimeSpent>
          <Billable>int</Billable>
          <RoleName>string</RoleName>
          <RoleRate>decimal</RoleRate>
          <WorkTypName>string</WorkTypName>
          <Notes>string</Notes>
          <Billed>boolean</Billed>
          <IsPosted>boolean</IsPosted>
        </api_GetTimeSheetsResult>
      </GetTimeSheetsResult>
      <outputMessage>string</outputMessage>
    </GetTimeSheetsResponse>
  </soap:Body>
</soap:Envelope>