API version 1 Appointments

1. List My Appointments (api1/appointments/my_appointments)

This method will answer with a collection of user's appointments of the current day that can check in and check out.

URL

Authorization

Response

[
        {
            "client_first_name": "James",
            "client_last_name": "Franco",
            "appointment_name": "abc",
            "appointment_start": "1704936600", // appointment time zone raw
            "appointment_finish": "1704937500", // appointment time zone raw
            "appointment_id": "4925",
            "appointment_address": "262 Kent Street",
            "latitude": "-12.82699366965845",
            "longitude": "-64.22187173858586",
            "case": "BD1009",
            "case_id": "1",
            "has_alert": "Yes/No",
            "appointment_duration": 900,
            "appointment_duration_string": "15m",
            "appointment_start_string": "12:00 PM", // user time zone
            "appointment_finish_string": "12:15 PM", // user time zone
            "appointment_time_zone": "Australia/Sydney",
            "check_in_date": null,
            "check_out_date": null,
            "overstay_time": 0,
            "user_time_zone": "Australia/Sydney"
        },
        {
            "client_first_name": "Jack",
            "client_last_name": "Black",
            "appointment_name": "abc",
            "appointment_start": "1704931200", // appointment time zone raw
            "appointment_finish": "1704932100", // appointment time zone raw
            "appointment_id": "4926",
            "appointment_address": "262 Kent Street",
            "latitude": "-12.82699366965845", 
            "longitude": "-61.22187173858586", 
            "case": "NSW1001",
            "case_id": "2",
            "has_alert": "Yes/No",
            "appointment_duration": 900,
            "appointment_duration_string": "15m",
            "appointment_start_string": "10:30 AM", // user time zone
            "appointment_finish_string": "10:45 AM", // user time zone
            "appointment_time_zone": "Australia/Sydney",
            "check_in_date": "1704919744",
            "check_out_date": "1704919798",
            "overstay_time": 1800 //time in seconds,
            "user_time_zone": "Australia/Sydney"
        }
    ]
    

2. Set Appointment Record (api1/appointments/my_appointments/set_record)

This method will allow to check-in, overstay and check-out an appointment and set an emergency.

URL

Authorization

Query Params

Response

      {
        "response": "Record successfuly saved",
        "appointment_id": "4927",
        "type": "Check-in"
      }
    

3. Undo check-in (api1/appointments/my_appointments/undo_check_in)

This method will allow to undo check-in to an appointment.

URL

Authorization

Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)

Response

    {
      "response": "Undid check-in successfuly.",
      "appointment_id": "4927"
    }
    

4. List users emergencies (api1/appointments/my_appointments/emergencies)

This method will answer with a collection of user's requested emergencies of the current day.

URL

Authorization

Response

[
        {
            "time": "04:43 AM",
            "description": "Call the cops"
        },
        {
            "time": "04:50 AM",
            "description": "Call the ambulance"
        }
    ]
    

5. List Appointments (api1/appointments)

This method will answer with a collection of appointments. The collection will be in JSON format and the date will be formated with the user's timezone format.

URL

Authorization

Query Params

Response

[
    {
        "id": "4923",
        "title": "Appoitmnet 1",
        "start": "2024-01-09 20:30:00",
        "end": "2024-01-09 21:00:00",
        "all_day_event": "Yes/No",
        "is_recurrent": "Yes/No",
        "client_reply": "Yes/No",
        "status": "Confirmed",
        "status_color": "92bcdc",
        "category": "Appointment",
        "client_name": "Client 3 (BD1008)",
        "resources": "",
        "outstanding_amount": "Yes/No",
        "case_id": "6",
        "has_alert": "Yes/No",
        "no_linked_billing": "Yes/No",
        "draft_counter": 0,
        "invoiced_counter": 0,
        "uninvoiced_counter": 0,
        "invoice_paid_counter": 0,
        "invoice_partially_paid_counter": 0,
        "invoiced_counter": 1,
        "has_online_meeting": "Yes/No",
        "employees": [
            {
                "user_id": "3",
                "name": "Jhon Doe"
            }
        ]
    },
    {
        "id": "4922",
        "title": "Appoitmnet 2",
        "start": "2024-01-10 06:15:00",
        "end": "2024-01-10 09:30:00",
        "all_day_event": "Yes/No",
        "is_recurrent": "Yes/No",
        "client_reply": "Yes/No",
        "status": "Cancelled",
        "status_color": "FF8787",
        "category": "Tasks",
        "client_name": "Client 2 (BD1019)",
        "resources": "",
        "outstanding_amount": "Yes/No",
        "case_id": "3",
        "has_alert": "Yes/No",
        "no_linked_billing": "Yes/No",
        "draft_counter": 0,
        "invoiced_counter": 0,
        "uninvoiced_counter": 1,
        "invoice_paid_counter": 0,
        "invoice_partially_paid_counter": 0,
        "invoiced_counter": 0,
        "has_online_meeting": "Yes/No",
        "employees": [
            {
                "user_id": "3",
                "name": "Jhon Doe"
            }
        ]
    },
    {
        "id": "4924",
        "title": "Appoitmnet 3",
        "start": "2024-01-10 10:00:00",
        "end": "2024-01-10 10:15:00",
        "all_day_event": "Yes/No",
        "client_reply": "Yes/No",
        "status": "Completed",
        "status_color": "92bcdc",
        "category": "Appointment",
        "client_name": "Client 1 (BD1009)",
        "resources": "MP Theatre | Music System", // resources are separeted by |
        "outstanding_amount": "Yes/No",
        "case_id": null,
        "has_alert": "Yes/No",
        "no_linked_billing": "Yes/No",
        "draft_counter": 0,
        "invoiced_count": 0,
        "uninvoiced_count": 0,
        "invoice_paid_count": 0,
        "invoice_partially_paid_count": 0,
        "invoiced_counter": 0,
        "has_online_meeting": "Yes/No",
        "employees": [
            {
                "user_id": "3",
                "name": "Jhon Doe"
            }
        ]
    }]
    

6. Get Appointments details (api1/appointments/details)

This method will answer with a collection of appointment's details. The collection will be in JSON format and the date will be formated with the appointment's timezone format.

URL

Authorization

Query Params

Response

    {
      "appointment_id": "4934",
      "case_id" : "1013",
      "title": "Appt title",
      "description": "This is a description",
      "start": "2024-01-24 11:30:00",
      "end": "2024-01-24 12:00:00",
      "allow_overlap": "Yes/No",
      "is_recurrent": "Yes/No",
      "all_day_event": "Yes/No",
      "time_zone": "Australia/Sydney",
      "status_id": "4125",
      "status": "Completed",
      "category_id": "4168",
      "category": "Task",
      "client_name": "Client Name (BD1009)",
      "case_id": "1013",
      "meeting_url": "url",
      "meeting_type": "Teams/Zoom/or empty",
      "location": "Other",
      "location_id": "-2", // -2 = other, -1 = client address, id > 0 office ID,
      "direction_id": "521",
      "case_notes": "Note with HTML",
      "street": "6 Help Street",
      "postcode": "2067",
      "suburb": "Chatswood",
      "sublocality": "City of Willoughby",
      "state": "New South Wales",
      "country": "Australia",
      "latitude": "-33.7959483",
      "longitude": "151.1797115",
      "care_of": "",
      "mmm_classification": "",
      "billing_total_outstatind": "$49.50",
      "billing_employee": "John Doe",
      "billing_employee_id": "210",
      "billing_employee_team": "Safety Team",
      "billing_employee_team_id": "4498",
      "billing_service_contract": "BD: AU Test",
      "billing_service_contract_id": "368",
      "billing": "Charge Code 4 : 1. Test",
      "billing_value": "00:00 100.00 1 0 1 0.00 1 0 0 0 Charge Code 4 2903",
      "billing_details": "dsfgdfg",
      "billing_description": "1. Test",
      "billing_code": "Charge Code 4",
      "employees": [
          {
              "user_id": "210",
              "name": "John Doe"
          }
      ],
      "resources": [
          {
              "id": "11",
              "name": "(SYD) Meeting Room 2"
          }
      ]
    }
    

7. List Appointment Employees (api1/appointments/employees)

This endpoint returns a collection of employee data that can be displayed on the calendar for the logged-in user. The response is in JSON format.

URL

Authorization

Query Params

Response

  
  [
    {
        "user_id": "20",
        "name": "Alexey Yaskin",
        "image": "default.png",
        "available": true,
        "events": []
    },
    {
        "user_id": "11",
        "name": "Amanda B",
        "image": "default.png",
        "available": false,
        "events": [{"title": "Meeting", "time": "10:00 AM"}]
    }
  ]
  

8. List Appointment Locations (api1/appointments/locations)

This method will answer with a collection of available appointment locations. The collection will be in JSON format.

URL

Authorization

Query Params

Response

      
[
      {
          "id": "2", // internal IInsight ID
          "name": "Office 2",
          "office_location": "306",
          "latitude": "10.1508842",
          "longitude": "10.6690775",
          "office_location_string": "150 Bourke Street, Woolloomooloo, City of Sydney, New South Wales, Australia, 2010"
      },
      {
          "id": "-1",
          "name": "Client Address"
      },
      {
          "id": "-2",
          "name": "Other"
      },
]
      
    

9. Add Event (api1/appointments/add_event)

This method will allow to create a new appointment/event in IInsight.

URL

Authorization

Query Params

Response Structure

A JSON object with the following attributes: success, message, error_type, confirm, data.

Failed Response

      
{
        "success": false,
        "message": "The following resources are not available",
        "errors_type": "unavailable_resources",
        "confirm": null,
        "data":
        [
            {
                "appointment_id": "3948",
                "appointment_name": "Test",
                "reservation_resource_date_start": "01-01-2024 12:30 pm",
                "reservation_resource_date_end": "01-01-2024 1:30 pm",
                "offices_department_name": "Office 1",
                "office_resource_id": "2",
                "office_resource_name": "Car",
                "office_resource_group": "Vehicles"
            },
            {
                "appointment_id": "3948",
                "appointment_name": "Test",
                "reservation_resource_date_start": "01-01-2024 12:30 pm",
                "reservation_resource_date_end": "01-01-2024 1:30 pm",
                "offices_department_name": "Office 1",
                "office_resource_id": "3",
                "office_resource_name": "Conference Room",
                "office_resource_group": "Rooms"
            },
        ]
}
      
    

Success Response

      
{
        "success": true,
        "message": "2 event(s) created.",
        "errors_type": null,
        "confirm": null,
        "data":
        {
            "appointmentIds":
            [
                3946,
                3947
            ]
        }
}
      
    

10. Delete event (api1/appointments/delete)

This method will allow to delete a event or recurrent events.

URL

Authorization

Query Params (As it's DELETE method this need to go on the x-www-form-urlencoded)

Failed Response

    {
      "success": false,
      "response": "You don't have permission to delete events"
    }
    

Success Response

    {
      "success": true,
      "response": "Appointment(s) successfuly deleted"
    }
    

11. Edit Event (api1/appointments/edit_event)

This method will allow to edit appointments/events in IInsight.

URL

Authorization

Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)

Response Structure

A JSON object with the following attributes: success, message, error_type, confirm, data.

Failed Response

      
{
        "success": false,
        "message": "The following resources are not available",
        "errors_type": "unavailable_resources",
        "confirm": null,
        "data":
        [
            {
                "appointment_id": "3948",
                "appointment_name": "Test",
                "reservation_resource_date_start": "01-01-2024 12:30 pm",
                "reservation_resource_date_end": "01-01-2024 1:30 pm",
                "offices_department_name": "Office 1",
                "office_resource_id": "2",
                "office_resource_name": "Car",
                "office_resource_group": "Vehicles"
            },
            {
                "appointment_id": "3948",
                "appointment_name": "Test",
                "reservation_resource_date_start": "01-01-2024 12:30 pm",
                "reservation_resource_date_end": "01-01-2024 1:30 pm",
                "offices_department_name": "Office 1",
                "office_resource_id": "3",
                "office_resource_name": "Conference Room",
                "office_resource_group": "Rooms"
            },
        ]
}
      
    

Success Response

      
{
        "success": true,
        "message": "2 event(s) edited.",
        "errors_type": null,
        "confirm": null,
        "data":
        {
            "appointmentIds":
            [
                3946,
                3947
            ]
        }
}
      
    

12. Recurrence Days (api1/appointments/recurrence_days)

This method returns a list of recurrence days for a given recurrence config.

URL

Authorization

Query Params

Response Structure

A JSON object with the following attributes: success, message, error_type, confirm, data.

Failed Response

      
{
        "success": false,
        "message": "Please provide a valid month number",
        "data": null
}
      
    

Success Response

      
{
        "success": true,
        "message": "Success Generation",
        "data":
        [
            {
                "date": "01-01-2024",
                "day": "Monday",
                "excluded": true
            },
            {
                "date": "05-01-2026",
                "day": "Monday",
                "excluded": false
            },
            {
                "date": "03-01-2028",
                "day": "Monday",
                "excluded": false
            }
        ]
}
      
    

13. List case appointments (api1/appointments/by_case_id)

This method returns a list appointments linked to a case.

URL

Authorization

Query Params

Response

      
{
        "success": true,
        "data":
        [
          {
            "id" => "1",
            "name" => "start date - appointment title"
          },
          {
            "id" => "2",
            "name" => "start date - appointment title"
          },
        ]
}