GetEmployees

This call is to retrieve an array of Employee objects for the location.

Response Parameters

Address1 string — Employee's address
Address2 string — Employee's address
AlternateId string — Alternate external Id for this Employee
BirthDate DateTime? — Employee's birth date (the time component will always return as 00:00:00)
CanLoginWithCard bool — True if Employee can login with a card, False if not
CanLoginWithFinger bool — True if Employee can login with their fingerprint, False if not
CanLoginWithPin bool — True if Employee can login with their PIN, False if not
CardNumber string — Employee's card number
CellPhone string — Employee's cell phone number
City string — Employee's city of residence
ClockedInDiscountId int? — Employee's discount Id when clocked in
ClockedOutDiscountId int? — Employee's discount Id when clocked out
DisplayName string — Employee's display name on the register
EmailAddress string — Employee's email address
EmployeeUniqueId Guid — Employee's unique identifier
ExportToPayroll bool — True if Employee should be exported to payroll, False if not
FirstName string — Employee's first name
HealthCardExpirationDate DateTime? — Date of expiration for the Employee's health card
HireDate DateTime? — Employee's hire date (the time component will always return as 00:00:00)
HomeLocationId Guid? — Employee's home location
HomePhone string — Employee's home phone
Id int — Unique Id in PAR POS for this Employee
IdentificationVerified bool — True if Employee's identity has been verified, False if not
IsExempt bool — True if Employee is tax exempt, False if not
IsSalaried bool — True if Employee is salaried, False if not
Jobs Array of EmployeeJob — Jobs assigned to this Employee
EmployeeJob Properties
- Id int — Unique Id of the Employee-Job relationship
- JobId int — Maps to the Id of the Job assigned to this Employee
- JobUniqueId Guid — Unique identifier of the Job assigned to this Employee
- PayRate decimal — Pay rate for this Employee in this Job
- SecurityLevelId int — Maps to the Id of the SecurityLevel for this EmployeeJob
- SecurityLevelUniqueId Guid — Unique identifier of the SecurityLevel for this EmployeeJob
LastName string — Employee's last name
LimitLocations bool — True if Employee's locations are limited, False if not
MaritalStatus byte — Returns one of the following:
- 0 = None
- 1 = Single
- 2 = Married
MaximumDailyDiscountAmount decimal — Maximum daily discount amount this Employee is allowed
MaximumDailyDiscountCount int — Maximum daily discount count this Employee is allowed
Notes string — Notes about this Employee
PayrollId string — Unique payroll Id for this Employee
Permissions Array of EmployeePermission — Permissions assigned to this Employee
EmployeePermission Properties
- Id int — Unique Id of the Employee-Permission relationship
- PermissionId int — Maps to the Id of the Permission granted to this Employee
- PermissionUniqueId Guid — Unique identifier of the Permission granted to this Employee
Pin string — PIN of this Employee. This value will always be null when returned.
SecondaryAuthPin string — Secondary Authentication PIN of this Employee.
State string — Employee's state of residence
TaxWithholdingAllowance int — Number of withholding allowances claimed
Terminated bool — True if Employee has been terminated, False if not
TerminationDate DateTime? — Employee's termination date, if applicable
ValidLocations Array of EmployeeLocation — Valid locations this Employee can work at
EmployeeLocation Properties
- Id int — Unique Id of the Employee-Location relationship
- LocationId Guid — Unique identifier of the Location this Employee is allowed to work at
Zip string — Employee's zip code

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetEmployees request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetEmployees

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetEmployees' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetEmployees"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetEmployees/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings2_GetEmployeesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <Settings2_GetEmployeesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Employees>
          <Employee>
            <Address1>123 Main St</Address1>
            <Address2/>
            <AlternateId>EMP001</AlternateId>
            <BirthDate i:nil="true"/>
            <CanLoginWithCard>true</CanLoginWithCard>
            <CanLoginWithFinger>false</CanLoginWithFinger>
            <CanLoginWithPin>true</CanLoginWithPin>
            <CardNumber>12345</CardNumber>
            <CellPhone>555-555-5555</CellPhone>
            <City>Austin</City>
            <ClockedInDiscountId i:nil="true"/>
            <ClockedOutDiscountId i:nil="true"/>
            <DisplayName>Jane Smith</DisplayName>
            <EmailAddress>jane.smith@example.com</EmailAddress>
            <EmployeeUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</EmployeeUniqueId>
            <ExportToPayroll>true</ExportToPayroll>
            <FirstName>Jane</FirstName>
            <HealthCardExpirationDate i:nil="true"/>
            <HireDate>2020-01-15T00:00:00</HireDate>
            <HomeLocationId i:nil="true"/>
            <HomePhone>555-444-3333</HomePhone>
            <Id>1</Id>
            <IdentificationVerified>false</IdentificationVerified>
            <IsExempt>false</IsExempt>
            <IsSalaried>false</IsSalaried>
            <Jobs>
              <EmployeeJob>
                <JobId>1</JobId>
                <JobUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</JobUniqueId>
                <PayRate>12.50</PayRate>
                <SecurityLevelId>2</SecurityLevelId>
                <SecurityLevelUniqueId>sec-00000-0000-0000-000000000002</SecurityLevelUniqueId>
              </EmployeeJob>
            </Jobs>
            <LastName>Smith</LastName>
            <LimitLocations>false</LimitLocations>
            <MaritalStatus>0</MaritalStatus>
            <MaximumDailyDiscountAmount>0</MaximumDailyDiscountAmount>
            <MaximumDailyDiscountCount>0</MaximumDailyDiscountCount>
            <Notes/>
            <PayrollId>P001</PayrollId>
            <Permissions/>
            <Pin i:nil="true"/>
            <SecondaryAuthPin i:nil="true"/>
            <Ssn>***-**-****</Ssn>
            <State>TX</State>
            <TaxWithholdingAllowance>1</TaxWithholdingAllowance>
            <Terminated>false</Terminated>
            <TerminationDate i:nil="true"/>
            <ValidLocations/>
            <Zip>78701</Zip>
          </Employee>
        </Employees>
      </Settings2_GetEmployeesResult>
    </Settings2_GetEmployeesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Employee objects.