Deployment

Description

On-demand REST API to retrive saved Falck Deployment 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, Deployment 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 scheduled shift 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
scheduleId	Float	598627685.0	Unique shift schedule ID
Name	String	"Abdallah, Mohamed"	Employee full name
BadgeNo	String	"368203"	Unique employee badge number
Start Date	String	"2022-02-23"	Employee scheduled shift start date. Format: YYYY-MM-DD
Shift Start Time	String	"2022-02-23 05:30:00"	Employee scheduled shift start date and time. Format: YYYY-MM-DD HH:MM:SS
Shift End Time	String	"2022-02-23 15:00:00"	Employee scheduled shift end date and time. Format: YYYY-MM-DD HH:MM:SS
Original Punch In	String	"2022-02-23 04:29:00"	Employee original shift punch in date and time. Format: YYYY-MM-DD HH:MM:SS
Original Punch Out	String	"2022-02-23 12:26:00"	Employee original shift punch out date and time. Format: YYYY-MM-DD HH:MM:SS
Punch In	String	"2022-02-23 04:30:00"	Employee shift punch in date and time. Format: YYYY-MM-DD HH:MM:SS
Punch Out	String	"2022-02-23 14:00:00"	Employee shift punch out date and time. Format: YYYY-MM-DD HH:MM:SS
Scheduled Hours	Float	8.5	Employee shift scheduled hours
Punched Hours	Float	8.5	Employee shift punched hours
Punch Type	Integer	1	auto = if punched hours is >= 17, missed = if punched hours == 0, valid = 17 < punched hours > 0
Punched Changed	String	Yes	Yes = Punched In/Out datetime different to Original Punched In/Out, otherwise No
In-day Overtime	Boolean	True	True = If Punched Hours > Scheduled Hours, otherwise False
Overtime Hours	Float	2.5	Employee overtime hours
Punch Attested	Boolean	True	True = If employee punched hours approved by the manager, otherwise False
Employee Comments	String	null	Comments provided by employee regarding scheduled shift
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/deployment?districtid=10291&unitid=60500&period=2023

Example Output

   
            [
                {
                    "scheduleId": 598627685.0,
                    "Name": "Abdallah, Mohamed",
                    "BadgeNo": "368203",
                    "Start Date": "2022-02-23",
                    "Shift Start Time": "2022-02-23 05:30:00",
                    "Shift End Time": "2022-02-23 15:00:00",
                    "Original Punch In": "2022-02-23 04:29:00",
                    "Original Punch Out": "2022-02-23 12:26:00",
                    "Punch In": "2022-02-23 04:30:00",
                    "Punch Out": "2022-02-23 14:00:00",
                    "Scheduled Hours": 8.5,
                    "Punched Hours": 8.5,
                    "Punch Type": "valid",
                    "Punched Changed": "Yes",
                    "In-day Overtime": 0,
                    "Overtime Hours": 0.0,
                    "Punch Attested": 1,
                    "Employee Comments": null,
                    "unitId": "60500",
                    "districtId": "10291",
                    "unitName": "Imperial"
                }, ...