DeploymentV2

Description

On-demand REST API to retrive saved Falck DeploymentV2 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, DeploymentV2 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

column_names = ["orgScheduleId", "scheduleId", 'absenceScheduleId', 'Name', 'categoryName', "BadgeNo", "Start Date", "Shift Start Time", "Shift End Time", 'begBreak', 'endBreak', "Scheduled Hours"]

Parameter	Type	Example	Comment
orgScheduleId	Float	598627685.0	In an absence shift this refers to the scheduled shift it origins from. On scheduled shifts and absence shifts that does not origin from a scheduled shift orgScheduleId = 0.
scheduleId	Float	598627685.0	Identificator for the scheduled shift. If record is not a scheduled shift scheduleId will be left out.
absenceScheduleId	Float	598627685.0	Identificator for the absence shift. If record is not an absence shift absencesheduleId will be left out.
Name	String	"Abdallah, Mohamed"	Employee full name
categoryName	String	People: Imperial-ACA-0600-1600	n/a
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
begBreak	String	"12:00:00"	Employee start break time. Format: HH:MM:SS
endBreak	String	"13:00:00"	Employee end break time. Format: HH:MM:SS
Scheduled Hours	Float	8.5	Employee shift scheduled 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/deploymentv2?districtid=10291&unitid=60500&period=2023

Example Output

   
            [
                {
                    "orgScheduleId": null,
                    "scheduleId": 598590983.0,
                    "absenceScheduleId": null,
                    "Name": "Yasin Abdi",
                    "categoryName": "People: Imperial - ACA - 0900-2030",
                    "BadgeNo": "373262",
                    "Start Date": "2022-06-20",
                    "Shift Start Time": "2022-06-20 09:00:00",
                    "Shift End Time": "2022-06-20 20:30:00",
                    "begBreak": "14:15:00.000000",
                    "endBreak": "15:15:00.000000",
                    "Scheduled Hours": 10.5,
                    "unitId": "60500",
                    "districtId": "10291",
                    "unitName": "Imperial"
                }, ...