LoadEntitlement

Load Entitlement Data

Description

The following are actions are executed when the loadentitlement REST API request is made:
1) Based on the provided District ID and Unit ID (optional), FRAWS will retrive the employee data from Quinyx WFM database using SOAP API.
2) The SOAP API XML response is converted to Pandas Data Frame object and stored in local FRAWS database.
3) The new/updated entitlement data can be retrive using the https://falckws/entitlement?districtid=10291 REST API.
4) The API query paramters MUST NOT CONTAIN QUOTES (i.e, Not Valid: district="60500", Valid: districtid=60500)
5) NOTE: THIS API QUERY CANNOT BE USED IN POWER BI, PLEASE USE POSTMAN TO SEND THE API QUERY.

Parameter	Requirement Level	Default	Comment
districtid	required	10291	Unique District ID number
unitid	optional	60500	Unique Business Unit ID number for specific District. Omit this parmaeter to get all units in the District ID
overwrite	required	0 or 1	WARNING: Setting overwrite to 1 will replace the local database table with the new data. Set overwrite to 0 to merge the new data with the exisiting one.
concurrent	required	0 or 1	When concurrent is set to 1, FRAWS will execute multiple Quinyx SOAP API calls at the same time to reduce the API call and processing time.
start	required	start or status	By providing start keyword, FRAWS will start the SOAP API calls to Quinyx WFM. If status keyword is set, FRAWS will check the current load status.
period	String	"2023"	Return employee data only for the specified year.

Input

Parameter Requirement Level Default Comment

districtid required 10291 Unique District ID number

unitid optional 60500 Unique Business Unit ID number for specific District. Omit this parmaeter
to get all units in the District ID

overwrite required 0 or 1 WARNING: Setting overwrite to 1 will replace the local database table with the new data.
Set overwrite to 0 to merge the new data with the exisiting one.

concurrent required 0 or 1 When concurrent is set to 1, FRAWS will execute multiple Quinyx SOAP API
calls at the same time to reduce the API call and processing time.

start required start or status By providing start keyword, FRAWS will start the SOAP API calls to Quinyx WFM.
If status keyword is set, FRAWS will check the current load status.

period String "2023" Return employee data only for the specified year.

Example Query

https://falckws.com/loadentitlement?districtid=10291&unitid=60500&period=2023&concurrent=0&overwrite=0&start

Example Output

   
            {
                "Request": "Read Deployment Data Table From Quinyx",
                "Status": "Send"
            }