GetEmployees

Retrieve the Employees for this location.

Note: We recommend using Settings2.svc for the GetEmployees call as this is deprecated in Settings.svc.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 3 — Server Unavailable
- 4 — Access Denied
Employees Array of Employee — Array of Employee objects for this location.
Employee Properties
- Address1 string — Employee's street address line 1
- Address2 string — Employee's street address line 2
- BirthDate DateTime — Employee's birth date
- CellPhone string — Employee's cell phone number
- City string — Employee's city of residence
- EmailAddress string — Employee's email address
- EmployeeUniqueId Guid — Employee's unique identifier
- FirstName string — Employee's first name
- HireDate DateTime — Employee's hire date
- HomePhone string — Employee's home phone number
- Id int — Unique Id of this Employee in PAR POS
- IdentificationVerified bool — True if Employee's identity has been verified, False if not
- Jobs Array of EmployeeJob — Jobs assigned to this Employee
  EmployeeJob Properties
  - 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
- MaritalStatus byte — Marital status of this Employee
- MiddleName string — Employee's middle name
- Name string — Full name of this Employee
- Notes string — Notes about this Employee
- PayrollId string — Unique payroll Id for this Employee
- State string — Employee's state of residence
- TaxWithholdingAllowance int — Number of withholding allowances claimed by this Employee
- Terminated bool — True if Employee has been terminated, False if not
- TerminationDate DateTime — Employee's termination date, if applicable
- Zip string — Employee's zip code

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetEmployees request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetEmployees

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetEmployees' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetEmployees"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetEmployees>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetEmployees>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetEmployeesResponse xmlns="http://tempuri.org/">
      <Settings_GetEmployeesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Employees>
          <Employee>
            <Address1>123 Main St</Address1>
            <Address2>Apt 4B</Address2>
            <BirthDate>1990-05-15</BirthDate>
            <CellPhone>555-123-4567</CellPhone>
            <City>Atlanta</City>
            <EmailAddress>jane.doe@example.com</EmailAddress>
            <EmployeeUniqueId>aaaaaaaa-0000-0000-0000-000000000042</EmployeeUniqueId>
            <FirstName>Jane</FirstName>
            <HireDate>2020-01-15</HireDate>
            <HomePhone>555-987-6543</HomePhone>
            <Id>42</Id>
            <IdentificationVerified>true</IdentificationVerified>
            <Jobs>
              <EmployeeJob>
                <JobId>101</JobId>
                <JobUniqueId>cccccccc-0000-0000-0000-000000000101</JobUniqueId>
                <PayRate>15.50</PayRate>
                <SecurityLevelId>2</SecurityLevelId>
                <SecurityLevelUniqueId>dddddddd-0000-0000-0000-000000000002</SecurityLevelUniqueId>
              </EmployeeJob>
            </Jobs>
            <LastName>Doe</LastName>
            <MaritalStatus>0</MaritalStatus>
            <MiddleName>M</MiddleName>
            <Name>Jane Doe</Name>
            <Notes>Excellent server</Notes>
            <PayrollId>EMP-042</PayrollId>
            <State>GA</State>
            <TaxWithholdingAllowance>2</TaxWithholdingAllowance>
            <Terminated>false</Terminated>
            <TerminationDate/>
            <Zip>30301</Zip>
          </Employee>
        </Employees>
      </Settings_GetEmployeesResult>
    </Settings_GetEmployeesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Employee objects.