GetEmployee
URL

https://go.paycycle.com.au/API/Employee/Employee.svc/GetEmployee

Description

This method retrieves the specified employee for the customer making the request.

Input

    <GetEmployeeRequest xmlns="http://api.paycycle.com.au/v1.0">

        <ApiKey/>00000000-0000-0000-0000-000000000000</ApiKey>

        <AuthorisationKey/>00000000-0000-0000-0000-000000000000</AuthorisationKey>

        <EmployeeID/>2022</EmployeeID>

    </GetEmployeeRequest>

Output

    <GetEmployeeResponse xmlns="http://api.paycycle.com.au/v1.0">

        <Status/>OK</Status>

        <ErrorDescription/></ErrorDescription>

        <Employee>

            <EmployeeID/>2022</EmployeeID>

            <FirstGivenName/>John</FirstGivenName>

            <HasOrdinaryEarningsRate/>true</HasOrdinaryEarningsRate>

            <Surname/>Smith</Surname>

        </Employee>

    </GetEmployeeResponse>

 

The response is a single employee or nil if no employee is found for the customer making the request. Employee ID is the internal identifier for the employee. HasOrdinaryEarningsRate indicates whether the employee has an ordinary earnings rate in Paycycle.