GET api/EmployeeBasic
Gets a list of Employees live from a payroll database. This call can be used to synchronise your system.
Request Information
URI Parameters
(i.e.queryString parameters in the form ?param1={param1}¶m2={param2})
| Name | Description | Type | Additional information |
|---|---|---|---|
| include Terminated |
Set to true to also include employees terminated after the terminatedSince date, false to exclude all terminated employees (mandatory). |
boolean |
Required |
| terminatedSince |
Terminated employees will only be incuded if they were terminated after this date and only if include terminated is set true (mandatory). Date Formats supported include: yyyy/mm/dd, yyyy/mmm/dd, yyyy-mm-dd, yyyy-mmm-dd. Generally any unambiguous date format is acceptable. Times can also be included: Thh:mm:ss |
date |
Required |
| page |
The page number to return using the pageSize parameter to define pages. Defaults to 1. |
integer |
Default value is 1 |
| pageSize |
The page size (number of records) to be used to find the record for the page requested. Defaults to 1000. |
integer |
Default value is 1000 |
Body Parameters
None.
Response Information
Resource Description
A list of all Employees' basic record
PagedObjectOfEmployeeBasicView| Name | Description | Type | Additional information |
|---|---|---|---|
| Items |
Collection of EmployeeBasic View |
None. |
|
| PageInfo | PagedListPageInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"items": [
{
"idEmployee": 1,
"empCode": "sample string 2",
"surname": "sample string 3",
"firstName": "sample string 4",
"middleName": "sample string 5",
"preferredName": "sample string 6",
"title": "sample string 7",
"gender": "sample string 8",
"maritalStatus": "sample string 9",
"dateOfBirth": "2024-05-19T04:16:10.2888175+10:00",
"hiredDate": "2024-05-19T04:16:10.2888175+10:00",
"aboriginalTorresStrait": "sample string 10",
"street": "sample string 11",
"suburbCity": "sample string 12",
"state": "sample string 13",
"postcode": "sample string 14",
"country": "sample string 15",
"postalStreet": "sample string 16",
"postalSuburbCity": "sample string 17",
"postalState": "sample string 18",
"postalPostcode": "sample string 19",
"postalCountry": "sample string 20",
"telephone1": "sample string 21",
"telephone2": "sample string 22",
"defaultEmail": "sample string 23",
"payrollCompany": "sample string 24",
"payFrequency": "sample string 25",
"location": "sample string 26",
"payPoint": "sample string 27",
"workersCompCode": "sample string 28",
"jobClassification": "sample string 29",
"userDefinedFields": "sample string 30",
"isAnnualisedSalary": true,
"annualisedAnniversaryDate": "2024-05-19T04:16:10.2888175+10:00"
},
{
"idEmployee": 1,
"empCode": "sample string 2",
"surname": "sample string 3",
"firstName": "sample string 4",
"middleName": "sample string 5",
"preferredName": "sample string 6",
"title": "sample string 7",
"gender": "sample string 8",
"maritalStatus": "sample string 9",
"dateOfBirth": "2024-05-19T04:16:10.2888175+10:00",
"hiredDate": "2024-05-19T04:16:10.2888175+10:00",
"aboriginalTorresStrait": "sample string 10",
"street": "sample string 11",
"suburbCity": "sample string 12",
"state": "sample string 13",
"postcode": "sample string 14",
"country": "sample string 15",
"postalStreet": "sample string 16",
"postalSuburbCity": "sample string 17",
"postalState": "sample string 18",
"postalPostcode": "sample string 19",
"postalCountry": "sample string 20",
"telephone1": "sample string 21",
"telephone2": "sample string 22",
"defaultEmail": "sample string 23",
"payrollCompany": "sample string 24",
"payFrequency": "sample string 25",
"location": "sample string 26",
"payPoint": "sample string 27",
"workersCompCode": "sample string 28",
"jobClassification": "sample string 29",
"userDefinedFields": "sample string 30",
"isAnnualisedSalary": true,
"annualisedAnniversaryDate": "2024-05-19T04:16:10.2888175+10:00"
}
],
"pageInfo": {
"page": 1,
"pageSize": 2,
"totalCount": 3,
"totalPages": 4,
"countThisPage": 5,
"hasPreviousPage": true,
"hasNextPage": true,
"errorMessage": "sample string 8"
}
}
application/xml, text/xml
Sample:
<PagedObjectOfEmployeeBasicView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Items>
<EmployeeBasicView>
<idEmployee>1</idEmployee>
<EmpCode>sample string 2</EmpCode>
<Surname>sample string 3</Surname>
<FirstName>sample string 4</FirstName>
<MiddleName>sample string 5</MiddleName>
<PreferredName>sample string 6</PreferredName>
<Title>sample string 7</Title>
<Gender>sample string 8</Gender>
<MaritalStatus>sample string 9</MaritalStatus>
<DateOfBirth>2024-05-19T04:16:10.2888175+10:00</DateOfBirth>
<HiredDate>2024-05-19T04:16:10.2888175+10:00</HiredDate>
<AboriginalTorresStrait>sample string 10</AboriginalTorresStrait>
<Street>sample string 11</Street>
<SuburbCity>sample string 12</SuburbCity>
<State>sample string 13</State>
<Postcode>sample string 14</Postcode>
<Country>sample string 15</Country>
<PostalStreet>sample string 16</PostalStreet>
<PostalSuburbCity>sample string 17</PostalSuburbCity>
<PostalState>sample string 18</PostalState>
<PostalPostcode>sample string 19</PostalPostcode>
<PostalCountry>sample string 20</PostalCountry>
<Telephone1>sample string 21</Telephone1>
<Telephone2>sample string 22</Telephone2>
<DefaultEmail>sample string 23</DefaultEmail>
<PayrollCompany>sample string 24</PayrollCompany>
<PayFrequency>sample string 25</PayFrequency>
<Location>sample string 26</Location>
<PayPoint>sample string 27</PayPoint>
<WorkersCompCode>sample string 28</WorkersCompCode>
<JobClassification>sample string 29</JobClassification>
<UserDefinedFields>sample string 30</UserDefinedFields>
<IsAnnualisedSalary>true</IsAnnualisedSalary>
<AnnualisedAnniversaryDate>2024-05-19T04:16:10.2888175+10:00</AnnualisedAnniversaryDate>
</EmployeeBasicView>
<EmployeeBasicView>
<idEmployee>1</idEmployee>
<EmpCode>sample string 2</EmpCode>
<Surname>sample string 3</Surname>
<FirstName>sample string 4</FirstName>
<MiddleName>sample string 5</MiddleName>
<PreferredName>sample string 6</PreferredName>
<Title>sample string 7</Title>
<Gender>sample string 8</Gender>
<MaritalStatus>sample string 9</MaritalStatus>
<DateOfBirth>2024-05-19T04:16:10.2888175+10:00</DateOfBirth>
<HiredDate>2024-05-19T04:16:10.2888175+10:00</HiredDate>
<AboriginalTorresStrait>sample string 10</AboriginalTorresStrait>
<Street>sample string 11</Street>
<SuburbCity>sample string 12</SuburbCity>
<State>sample string 13</State>
<Postcode>sample string 14</Postcode>
<Country>sample string 15</Country>
<PostalStreet>sample string 16</PostalStreet>
<PostalSuburbCity>sample string 17</PostalSuburbCity>
<PostalState>sample string 18</PostalState>
<PostalPostcode>sample string 19</PostalPostcode>
<PostalCountry>sample string 20</PostalCountry>
<Telephone1>sample string 21</Telephone1>
<Telephone2>sample string 22</Telephone2>
<DefaultEmail>sample string 23</DefaultEmail>
<PayrollCompany>sample string 24</PayrollCompany>
<PayFrequency>sample string 25</PayFrequency>
<Location>sample string 26</Location>
<PayPoint>sample string 27</PayPoint>
<WorkersCompCode>sample string 28</WorkersCompCode>
<JobClassification>sample string 29</JobClassification>
<UserDefinedFields>sample string 30</UserDefinedFields>
<IsAnnualisedSalary>true</IsAnnualisedSalary>
<AnnualisedAnniversaryDate>2024-05-19T04:16:10.2888175+10:00</AnnualisedAnniversaryDate>
</EmployeeBasicView>
</Items>
<PageInfo>
<Page>1</Page>
<PageSize>2</PageSize>
<TotalCount>3</TotalCount>
<TotalPages>4</TotalPages>
<CountThisPage>5</CountThisPage>
<HasPreviousPage>true</HasPreviousPage>
<HasNextPage>true</HasNextPage>
<ErrorMessage>sample string 8</ErrorMessage>
</PageInfo>
</PagedObjectOfEmployeeBasicView>