Entitlement

Description

On-demand REST API to retrive saved Falck Entitlement data from local database.
The API requires a mandatory input districtid and a optional input unitid. To retrive all Business Units for a District, ommit unitid input parameter.
The API response, Entitlement data is in JSON format. The API query can be used in any REST API supported tools.
The example API query below will retrieve the employee's time tracker data for Imperial Business Unit in Operations District.

Parameter	Requirement Level	Default	Comment
districtid	required	n/a	Unique District ID number
unitid	optional	n/a	Unique Business Unit ID number for specific District
period	String	"2023"	Return employee data only for the specified year.

Input

Parameter Requirement Level Default Comment

districtid required n/a Unique District ID number

unitid optional n/a Unique Business Unit ID number for specific District

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

Output

Parameter	Type	Example	Comment
BadgeNo	String	"368203"	Unique employee badge number
Name	String	"Abdallah, Mohamed"	Employee full name
Contract	String	"Static"	Employee contract type
Active	Integer	1	0 = Employee last day of employment set, 1 = Employee is active
SkillList	String	"Intermediate Care Technician"	List of employee skills
Agreement Template	String	"Medical Services Static 4/4 & 4/3 (NEW),Falck Static 4/4 (NEW)"	Employee Agrement Template required for employee to be scheduled
StartDate	String	"2007-10-08"	Employee start date in the following format: "YYYY-MM-DD"
EndDate	String	"2008-11-08"	Employee last day of employment in the following format: "YYYY-MM-DD"
Entitlement	Float	17.5	Employee total entitlement hours
Used	Float	13.0	Entitlement hours used by employee
Balance	Float	13.0	Remaining employee entitlement hours
unitId	String	"60500"	Unique Business Unit ID number for a specific District
districtId	String	"10291"	Unique District ID
unitName	String	"Imperial"	Unique Business Unit name for a specific District

Example Query

https://falckws.com/entitlement?districtid=10291&unitid=60500&period=2023

Example Output

   
            [
                {
                    "BadgeNo": "112427",
                    "Name": "Peter Jones",
                    "Contract": "Static",
                    "Active": 1,
                    "SkillList": "Intermediate Care Technician",
                    "Agreement Template": "Medical Services Static 4/4 & 4/3 (NEW),Falck Static 4/4 (NEW)",
                    "StartDate": "2007-10-08",
                    "EndDate": null,
                    "Entitlement": 17.5,
                    "Used": 13.0,
                    "Balance": 4.5,
                    "unitId": "60500",
                    "districtId": "10291",
                    "unitName": "Imperial"
                }, ...