SaveEmployees

Create or update one or more Employees at a location.

Request Parameters

Employees Array of Employee — Specify one or more Employee objects you would like to create and/or update.
Employee Properties
- 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

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
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
SaveResults Array of KeyedSettingsObjectSaveResult — Details about the outcome of your request.
KeyedSettingsObjectSaveResult Properties
- Id int — New Id of the Employee created
- OriginalId int — Original Id in the Employee creation request
- ValidationMessages Array of string — Details if the request was unsuccessful
ValidationMessages List<string> — Details if the request was unsuccessful.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for SaveEmployees request containing employee details.

Responses

text/xml; charset=utf-8

post/SaveEmployees

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?SaveEmployees' \
  --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/SaveEmployees"' \
  --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:SaveEmployees>
        <v2:request>
          <v2:Employees>
            <v2:Employee>
              <v2:Id>-1</v2:Id>
              <v2:DisplayName>John Doe</v2:DisplayName>
              <v2:FirstName>John</v2:FirstName>
              <v2:LastName>Doe</v2:LastName>
            </v2:Employee>
          </v2:Employees>
        </v2:request>
      </v2:SaveEmployees>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveEmployeesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <SaveEmployeesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <SaveResults>
          <KeyedSettingsObjectSaveResult>
            <Id>12345</Id>
            <OriginalId>-1</OriginalId>
            <ValidationMessages/>
          </KeyedSettingsObjectSaveResult>
        </SaveResults>
        <ValidationMessages/>
      </SaveEmployeesResult>
    </SaveEmployeesResponse>
  </s:Body>
</s:Envelope>

SOAP response with saved employee Id(s) and ResultCode (0 = success).