Documentation Contents
Important: An API Key is required to work with these API Calls
Important: API calls use a RESTful architecture and are in JSON format
API Calls currently available
- User calls
- login (Log in a user based on their username and password)
- Survey calls
- assignments (List a users assignment)
- get_assignment (Get the details of a specific assignment)
- assignment_history (List the assigments a user has completed)
- submit_assignment (Submit a completed assignment)
- cancel_assignment (Cancel a assignment)
- surveys (Get all survey IDs, titles and date last updated)
- get_survey (Get the full details of a survey)
- submit_image (Submit an image)
- remove_image (Remve an uploaded image)
- submit_video (Submit a video)
- remove_video (Remve an uploaded video)
- items (Get the Q-Diary for a given day)
- items2 (Get the Q-Diary for a given day in JSON format)
- save_event (Add/edit events)
- get_event (Get Event's details by ID)
- get_irishwater_answers (Get the question answers for a Irish Water form)
- get_wayleave_answers (Get the question answers for a wayleave)
- get_upc_wayleave_answers (Get the question answers for a UPC Wayleave)
- Data calls
- client_list (List of clients a user has access)
- department_list (List of departments a user has access)
- completion_code_list (List of completion codes)
- project_list (List of Projects)
- account_list (List of Account Numbers)
- location_list (List of Locations)
- activity_type_list (List of Job Types)
- project_name_list (List of Project Names)
- android_version (Get the required version of the Android app)
- panic_button (Processes the panic button alerts)
- stop_panic (Stops the panic button alert)
- get_shapes (List the predefined shapes)
- work_id_list (List of work ids)
- wayleave_project_code_list (List of project codes)
- wayleave_project_name_list (List of project names)
- wayleave_no_list (List of wayleave numbers)
- wayleave_details (Details of a landowner)
- work_order_list (Work order ID list)
- full_work_order_list (Work order ID full list)
- work_order_wayleave_details (Details of a landowner for a given work order)
- upc_wayleave_files (Get the list of files attached to a UPC Wayleave)
- Document calls
- group_list (List of document groups a user has access)
- file_list (List of files inside a folder. The user must have access to that group)