Skip to content

Move Employees

Operation
wsdlMoveEmployees
SOAP Action
uri:FlexForce/wsdlMoveEmployees
Service
FlexForce
Port
FlexForcePort
Style
rpc

Schedule the move of one or more employees from their current home unit to another, with deferred effective dates.

The wsdlMoveEmployees method provides an alternative method of moving employees from one home unit to another. Normally, an employee is moved from one home unit to another by providing the new home unit’s API key in wsdlUpdateEmployees. However, using this method the employee is moved immediately as soon as the call is complete. With wsdlMoveEmployees it is possible to schedule the employee for moving in the future.

The move process

The move happens in three steps:

  1. sharableOnNewUnitFrom — the employee is shared to the new unit so they become available for scheduling there.
  2. newUnitStartDate — the employee is moved to the new unit, the previous share is closed, and attributes such as section and reportingTo are updated. The employee is then shared back to the previous unit so administration can still be performed there.
  3. oldUnitEndShareDate — the share with the previous unit is closed, completing the move.

Updating a scheduled move

A moveId is returned when the move is requested. Pass that identifier in a future call to amend a scheduled move, subject to these limits:

  • The move must not have been initiated yet.
  • Only the following fields can be altered: sharableOnNewUnitFrom, newUnitStartDate, oldUnitEndShareDate, reportingTo, section, costCentre.

Request

Message: wsdlMoveEmployeesRequest

apiKeystring

API key of the unit the employee is moving **to**.

moveEmployeesArray<moveEmployee>

Array of moveEmployee records — one per employee to move.

itemmoveEmployee

A single scheduled employee move, used by wsdlMoveEmployees.

badgeNostringrequired

Employee badge number.

unitExtCodestring

Legacy field. When supplied, overrides the target unit implied by the apiKey. New unit external code defined under *Settings → Tables → Integration key types*.

newUnitStartDatestringrequired

Date the employee is actually moved to the new home unit.

FormatYYYY-MM-DD
oldUnitEndShareDatestringrequired

Date the share with the old unit ends.

FormatYYYY-MM-DD
sharableOnNewUnitFromstringrequired

Date the employee becomes shared to the new unit.

FormatYYYY-MM-DD
sectionstring

External code defined under *Settings → Tables → Integration key types* and Integration keys. When omitted, the section is reset on the employee after the move.

costCentrestring

External code defined under *Settings → Tables → Cost centres*.

reportingTostring

Badge number of the employee's manager. Must be a user with a higher role than the employee on any group, or (in Classic) a staff category at or above section manager. When omitted, reportingTo is reset on the employee after the move.

moveIdstring

Identifier of the scheduled move. Generated and returned on the initial request; pass it back to amend a pending move.

validationErrorsArray<xsd:string>required

Array of validation errors. Empty on success.

curl -X POST 'https://api.quinyx.com/FlexForceWebServices.php' \
  -H 'Content-Type: text/xml; charset=utf-8' \
  -H 'SOAPAction: "uri:FlexForce/wsdlMoveEmployees"' \
  --data @- <<'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlMoveEmployees>
    <apiKey xsi:type="xsd:string">string</apiKey>
    <moveEmployees xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:moveEmployee[1]">
      <item xsi:type="tns:moveEmployee">
        <badgeNo xsi:type="xsd:string">string</badgeNo>
        <unitExtCode xsi:type="xsd:string">string</unitExtCode>
        <newUnitStartDate xsi:type="xsd:string">string</newUnitStartDate>
        <oldUnitEndShareDate xsi:type="xsd:string">string</oldUnitEndShareDate>
        <sharableOnNewUnitFrom xsi:type="xsd:string">string</sharableOnNewUnitFrom>
        <section xsi:type="xsd:string">string</section>
        <costCentre xsi:type="xsd:string">string</costCentre>
        <reportingTo xsi:type="xsd:string">string</reportingTo>
        <moveId xsi:type="xsd:string">string</moveId>
        <validationErrors xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[1]">
          <item xsi:type="xsd:string">string</item>
        </validationErrors>
      </item>
    </moveEmployees>
    </tns:wsdlMoveEmployees>
  </soap:Body>
</soap:Envelope>
EOF

Response

Message: wsdlMoveEmployeesResponse

returnArray<moveEmployee>

Array of moveEmployee records reflecting the scheduled state (each carries the assigned moveId).

itemmoveEmployee

A single scheduled employee move, used by wsdlMoveEmployees.

badgeNostringrequired

Employee badge number.

unitExtCodestring

Legacy field. When supplied, overrides the target unit implied by the apiKey. New unit external code defined under *Settings → Tables → Integration key types*.

newUnitStartDatestringrequired

Date the employee is actually moved to the new home unit.

FormatYYYY-MM-DD
oldUnitEndShareDatestringrequired

Date the share with the old unit ends.

FormatYYYY-MM-DD
sharableOnNewUnitFromstringrequired

Date the employee becomes shared to the new unit.

FormatYYYY-MM-DD
sectionstring

External code defined under *Settings → Tables → Integration key types* and Integration keys. When omitted, the section is reset on the employee after the move.

costCentrestring

External code defined under *Settings → Tables → Cost centres*.

reportingTostring

Badge number of the employee's manager. Must be a user with a higher role than the employee on any group, or (in Classic) a staff category at or above section manager. When omitted, reportingTo is reset on the employee after the move.

moveIdstring

Identifier of the scheduled move. Generated and returned on the initial request; pass it back to amend a pending move.

validationErrorsArray<xsd:string>required

Array of validation errors. Empty on success.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlMoveEmployeesResponse>
    <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:moveEmployee[1]">
      <item xsi:type="tns:moveEmployee">
        <badgeNo xsi:type="xsd:string">string</badgeNo>
        <unitExtCode xsi:type="xsd:string">string</unitExtCode>
        <newUnitStartDate xsi:type="xsd:string">string</newUnitStartDate>
        <oldUnitEndShareDate xsi:type="xsd:string">string</oldUnitEndShareDate>
        <sharableOnNewUnitFrom xsi:type="xsd:string">string</sharableOnNewUnitFrom>
        <section xsi:type="xsd:string">string</section>
        <costCentre xsi:type="xsd:string">string</costCentre>
        <reportingTo xsi:type="xsd:string">string</reportingTo>
        <moveId xsi:type="xsd:string">string</moveId>
        <validationErrors xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[1]">
          <item xsi:type="xsd:string">string</item>
        </validationErrors>
      </item>
    </return>
    </tns:wsdlMoveEmployeesResponse>
  </soap:Body>
</soap:Envelope>