Responders



Options:

refer to docs for full details

item type mandatory description comments
fire_fighter_barcode string Unique id Assigned by server
first_name string Responders preferred first name Title-case
last_name string Responders last name Title-case
primary_contact string Preferably mobile number This is the number used for SMS notifications
secondary contact string Can be mobile or landline Non-mandatory
org_uid string Organisations unique_id for responder Must be unique within your organisation
adhoc_upload boolean Used to differentiate recorded entered via system upload and those entered via front end as adhoc records Default value is false
archive boolean Used to archive/remove responders no longer required in Responder HQ Default value is false
email string This should match responders expected user-name for registering an account. For organisation staff the email address will be their organisation email address. For contractor's it can be any address, but the individual needs to have access to the address. Must be unique
fire_qual string Abbreviation - matching the competency abbreviation. refer to competencies Indicates a responder's highest field qualification e.g. CL or Crew Leader. The fire_qual field is used to suffix the responder name to provide some guidance of the responders capability
fitness integer Provides fitness indicator for field roles, currently based on standard pack test (using values of 1, 2, 3 & 4) 1=Arduous, 2=Moderate, 3=Light, 4=Untested, 5=Short-term restricted, 6=Long-term restricted, 7=Unknown
medical_info string Any medical information that the responder has consented to list in Responder HQ Examples could include allergies, diabetes. This information is accessible by dispatchers and administrators and may be incorporated into summary reports
dietary_requirements string Any dietary requirements that the responder has consented to list in Responder HQ This information is accessible by dispatchers and administrators and may be incorporated into summary reports (e.g. for logistics and meal requirements)
home locality string Suburb level locality for the responders home location Used to assist with estimating travel times and localisation
depot location string Depot or office locality to indicate the responders base work location Used to assist with estimating travel times and localisation
category string "staff" or "contractor" All responders with "contractor" should have a matching contractor_id
staff_type string "Staff classification" Staff classification that may be required for backend reporting. e.g. Deployment reports for Payroll using award classification.
contractor_id integer Should be a contractor for your organisation For contractor_ids refer to contractors
home_region_id integer Region ids for your organisation are displayed here
deploy_region_id integer When new resources are added, the deploy_region_id should equal the home_region_id. This field is used as responders are transferred between "regions". If updating a responder, the deploy region_id should be passed back without change.

Example

{
"fire_fighter_barcode": "f1000",
"first_name": "Megan",
"last_name": "O'Niel",
"primary_contact": "0481 607 741",
"secondary_contact": "03 5725 1545",
"org_uid": "6202346",
"adhoc_upload": null,
"archive": null,
"email": "megan.o'niel@responderorg.com",
"fire_qual": "CL",
"fitness": 2,
"medical_info": null,
"dietary_requirements": null,
"home_locality": "Ashby",
"depot": "Upper Ashby",
"category": "staff",
"staff_type": "level_2",
"contractor_id": 0,
"home_region_id": 100,
"deploy_region_id": 100,
}