Staff

Description

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

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

Output

Parameter	Type	Example	Comment
BadgeNo	String	"112427"	Unique employee badge number
Active	Integer	1	0 = Employee is leaving, 1 = Employee is active
Name	String	"Peter Jones"	Employee full name
Contract	String	"Static"	Employee contract type
Job Title	String	"Intermediate Care Technician"	Employee job title
Employed Date	String	"2007-10-08"	Employee start date, format: "YYYY-MM-DD"
Leave Date	String, Null	"2008-10-08"	Employee leave date, format: "YYYY-MM-DD". Null value is set if the employee Active == 1
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/staff?districtid=10291&unitid=60500

Example Output

   
            [
                {
                    "BadgeNo": "112427",
                    "Active": 1,
                    "Name": "Peter Jones",
                    "Contract": "Static",
                    "Job Title": "Intermediate Care Technician",
                    "Employed Date": "2007-10-08",
                    "Leave Date": null,
                    "unitId": "60500",
                    "districtId": "10291",
                    "unitName": "Imperial"
                }, ...