Back to Service

Method Details for GetEmployeesShortList.

Gets a list of employees with key information only

Parameters

  • siteCode String Unique identification for your TimeLog account
  • apiID String The API ID
  • apiPassword String The API password
  • departmentID Integer ID of specific department. Set to 0 to get all employees
  • status Integer Set to 0 for inactive employees; 1 for active employees; -1 to get all employees

Returns

A list of employee objects in XML format

Result Example

<?xml version="1.0" encoding="utf-8"?>
<tlp:Employees xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://www.timelog.com/XML/Schema/tlp/v4_4 http://www.timelog.com/api/xsd/EmployeesShortList.xsd">
  <tlp:Employee ID="14">
    <tlp:EmployeeUserId>2</tlp:EmployeeUserId>
    <tlp:FirstName>Hans</tlp:FirstName>
    <tlp:LastName>Mustermann</tlp:LastName>
    <tlp:FullName>Hans Mustermann</tlp:FullName>
    <tlp:Initials>HMM</tlp:Initials>
  </tlp:Employee>
  <tlp:Employee ID="17">
		<tlp:FirstName>John</tlp:FirstName>
		<tlp:LastName>Doe</tlp:LastName>
		<tlp:FullName>John Doe</tlp:FullName>
		<tlp:Initials>JDO</tlp:Initials>
	</tlp:Employee>
</tlp:Employees>

Result Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4"
            targetNamespace="http://www.timelog.com/XML/Schema/tlp/v4_4"
            elementFormDefault="qualified"
            attributeFormDefault="unqualified">
	<xsd:element name="Employees" >
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="Employee" type="tlp:EmployeeShort_Type" minOccurs="0" maxOccurs="unbounded" />
			</xsd:sequence>
		</xsd:complexType>
		<xsd:key name="Employee_Key">
			<xsd:selector xpath=".//tlp:Employee" />
			<xsd:field xpath="@ID" />
		</xsd:key>
	</xsd:element>


	<xsd:complexType name="EmployeeShort_Type">
		<xsd:sequence>
			<xsd:element name="EmployeeUserId" type="xsd:positiveInteger" />
			<xsd:element name="FirstName" type="xsd:string" />
			<xsd:element name="LastName" type="xsd:string" />
			<xsd:element name="FullName" type="xsd:string" />
			<xsd:element name="Initials" type="xsd:string" />
		</xsd:sequence>
		<xsd:attribute name="ID" type="xsd:positiveInteger" use="required" />
	</xsd:complexType>

</xsd:schema>

Download the XSD