API version 1 Case

1. List Cases (api1/cases)

This method will answer with a collection of iinsight's cases (case oriented data). The collection wil be in JSON format.
The results would be paginated, having a maximum of 100 records per page. An empty collection and a status code 200 response, means that there is no records in the specified page.

URL

Authorization

Query Params

Response

[  
      {
        "case_n": "ACB1", 
        "case_number":"123", // internal iinsight ID
        "case_status_color":"hexacolor",
        "case_type": "client/company",
        "business_division":"xxxx",
        "client_name":"xxxx xxxx, xx",
        "assigned_to":"xxxx xxxx",
        "service_contract":"xxxx",
        "service_contract_id":"123",
        "client_first_name":"xxxx",
        "client_last_name":"xxxx",
        "client_title":"xxxx",
        "client_position":"xxxx",
        "client_department":"xxxx",
        "client_address":"####, xxxx, xxxx, xxxx",
        "client_email":"xxxx@mail.com",
        "client_phone1":"####",
        "client_phone2":"####",
        "client_fax":"####",
        "client_mobile":"####",
        "team":"xxxx",
        "condition":"xxxx",
        "diagnosed_injury":"xxxx",
        "cause":"xxxx",
        "condition_date":"##-##-####",
        "date_of_birth":"##-##-####",
        "date_opened":"##-##-####",
        "date_closed":"##-##-####",
        "date_of_referral":"##-##-####",
        "outcome":"xxxxx",
        "outcome_date":"##-##-####",
        "case_completed":"Yes/No",
        "reason_for_referral":"xxxxx",
        "employment_status":"xxxx",
        "case_status":"Open/Closed/Re-opened",
        "bill_to_first_name":"xxxx",
        "bill_to_last_name":"xxxx",
        "bill_to_company_name":"xxxx",
        "invoice_n":"###",
        "client_company_name":"xxxx",
        "claim_no":"###",
        "employeer":"xxxx",
        "pre_injury_hours":"##",
        "hours_stated_at_referral":"##",
        "current_hours_stated":"##",
        "internal_case_no":"###",
        "case_plan_start":"##-##-####",
        "case_plan_end":"##-##-####",
        "case_plan_budget":"$#.##",
        "service_provided_to":"xxxx",
        "ethnicity":"xxxx",
        "language":"xxxx",
        "interpreter":"xxx",
        "case_last_charge_code":"xxxx",
        "prior_status":"xxxx xxxx",
        "closure_status":"xxxx xxxx",
        "comments":"xxxx xxxx xxxx",
        "current_closure_codes":"xxx",
        "ccc_date":"##-##-####",
        "current_earnings":"$#.##",
        "ce_from":"##-##-####",
        "current_progress_codes":"xxx",
        "cpc_date":"##-##-####",
        "date_ceased_work":"##-##-####",
        "date_of_notification":"##-##-####",
        "ear":"$#.##",
        "init_date":"##-##-####",
        "init_time":"##:## am/pm",
        "con_date":"##-##-####",
        "con_time":"##:## am/pm",
        "gender":"xxxx",
        "last_closure_codes":"xxx",
        "lpc_date":"##-##-####",
        "lcc_date":"##-##-####",
        "last_progress_codes":"xxxx",
        "notonial_weekly_earnings":"$#.##",
        "outcome_date":"##-##-####",
        "primary_psychological_claim":"Yes/No",
        "reason_referral_personal":"xxxx",
        "reason_referral_work":"xxxx",
        "rcategory":"xxxx",
        "referral_source":"xxxx",
        "case_unbilled":"$#.##",
        "task_ref_no": "###",
        "business_unit_name":"xxx",
        "contract_no":"####",
        "case_approved_fund":"$#.##",
        "case_plan_remaining":"$#.##",
        "case_billed":"$#.##",
        "suitable_emp_goal":"xxxx",
        "durability_outcome1":"xxxxx",
        "durability_outcome2":"xxxxx",
        "durability_date1":"##-##-####",
        "durability_date2":"##-##-####",
        "first_reminder":"Disabled/Enabled/Overdue/Scheduled",
        "second_reminder": "Disabled/Enabled/Overdue/Scheduled"
        "case_last_cost_date":"##-##-####",
        "plan_claim_due_date":"##-##-####",
        "postcode":"###",
        "referral_id":"###",
        "authorised_by":"xxxx",
        "participant_approved":"xxxx",
        "funding_program":"xxxx",
        "case_plan_title":"xxxx",
        "case_plan_id":"xx##",
        "referral_type":"xxxx",
        "client_status_referral":"xxxx",
        "can_modify_case":"xxxx",
        "can_view_case":"xxxx",
        "referrer_company":"xxxx",
        "referrer_first_name":"xxxx",
        "referrer_last_name":"xxxx",
        "case_total_amount":"$#.##",
        "case_approved_duration":"#.##",
        "case_total_duration":"#.##",
        "case_remaining_duration":"#.##",
        "enable_case_alert":"Enabled/Disabled",
        "alert_message":"xxxxx",
    }
]

2. Client Details (api1/cases/client)

This method will answer with a collection of client details. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

  {
    "title": "xxx",
    "first_name": "xxx",
    "last_name": "xxx",
    "date_of_birth": "##-##-####",
    "age": "## years"
    "phone1": "###",
    "phone2": "###",
    "fax": "###",
    "mobile": "###",
    "email": "xxx@xxx.xxx",
    "direction_id": "773",
    "street": "# xxx xx",
    "postcode": "###",
    "suburb": "xxx",
    "sublocality": "xxx",
    "state": "xxx",
    "country": "xxx",
    "latitude": "###.###",
    "longitude": "###.###",
    "care_of": "###",
    "medicare_no": "X#X#",
    "medicare_irn": "xxx",
    "medicare_date": "##-##-####"
    "primary_physical_claim": "Yes/No",
    "primary_psychological_claim": "Yes/No",
    "nature_of_condition": "xxx",
    "diagnosed_condition": "xxxx",
    "cause": "xxx",
    "occurred": "##-##-####",
    "incident_direction_id": "1",
    "incident_street": "xxx",
    "incident_postcode": "xxx",
    "incident_suburb": "xxx",
    "incident_sublocality": "xxx",
    "incident_state": "xxx",
    "incident_country": "xxx",
    "incident_latitude": "xxx",
    "incident_longitude": "xxx",
    "incident_care_of": "xxx",
    "client_current_work_status": "xxxx",
    "position": "xxxx",
    "department": "xxxx",
    "deployment": "xxxx",
    "employer_company_id": "##" // internal iinsight ID
    "employer_id": "###", // internal iinsight ID
    "employer": "xxx",
    "employer_segment": "xxx",
    "pre_condition_hours": "##:##",
    "hours_stated_at_referral": "##:##",
    "current_hours_stated": "##:##",
    "certified_hours" : "##:##",
    "notional_weekly_earnings": "#.##",
    "earnings_at_referral": "#.##",
    "current_earnings": "#.##",
    "current_earnings_from": "##-##-####",
    "suitable_employment_goal": "xxx",
    "kin_first_name": "xxx",
    "kin_last_name": "xxx",
    "kin_relationship": "xxx",
    "kin_mobile": "###",
  }
    

3. Update Client Details (api1/cases/client/update)

This method will allow to update a client details in iinsight.

URL

Authorization

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

Response

    {
      "response": "Client details updated",
      "case_id": "#"
    }
    

4. List client's certified hours (api1/cases/client/certified_hours)

This method will answer with a collection of client's certified hours. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

    [
      {
          "date": "##-##-####",
          "old_value": "##:##",
          "new_value": "##:##"
      },
      {
          "date": "##-##-####",
          "old_value": "##:##",
          "new_value": "##:##"
      },
    ]
    

5. Case details (api1/cases/details)

This method will answer with a collection of case details. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

    {
    "case_number": "2",
    "case_n": "1094",
    "office_id": "1",
    "prefix": "Nat",
    "reason_for_referral": "test23",
    "referral_category": "test",
    "referrer_id": "736",
    "referrer": "Testing1",
    "referrer_company_id": "0",
    "referral_id": "123",
    "referral_type": "test",
    "referred_on": "12-10-2010",
    "acceptance_date": "10-10-2010",
    "delay_to_commencement": "test",
    "client_status_prior_to_referral": "test",
    "client_status_referral": "test",
    "client_status_at_case_closure": "test2",
    "referral_source": "test",
    "date_ceased_work": "10-10-2010",
    "last_progress_codes": "test233",
    "last_progress_code_date": "12-10-2014",
    "current_progress_codes": "qweqw",
    "current_progress_codes_date": "12-10-2015",
    "last_closure_codes": "test2",
    "last_closure_codes_date": "11-10-2010",
    "current_closure_codes": "CG",
    "current_closure_codes_date": "11-10-2010",
    "case_status": "Closed",
    "risk_category": "test123",
    "date_closed": "15-11-2024",
    "case_duration": "5104",
    "bill_to_id": "713",
    "bill_to": ",",
    "bill_to_company_id": "299",
    "date_opened": "25-11-2010",
    "date_reopened": "",
    "date_of_notification": "08-11-2010",
    "internal_case_no": "",
    "biller_code": "",
    "claim_no": "55555",
    "participant_no": "55555",
    "business_unit_name": "asdf",
    "task_ref_no": "asd",
    "contract_no": "",
    "outcome": "Assessment Only",
    "durability_outcome1": "test2",
    "durability_date1": "10-10-2012",
    "durability_outcome2": "Program completed, no return to wor",
    "durability_date2": "1423616400",
    "durability_reminder1": "No",
    "durability_reminder2": "No",
    "date_suspended": "",
    "assigned_to_id": "132",
    "assigned_to": "Hans Svane",
    "service_contract_id": "35",
    "service_contract": "Nat:Workcover",
    "additional_referral_particulars": "Test AR",
    "team_id": "0",
    "team": null,
    "revenue_centre_id": "1",
    "revenue_centre": "Burns (right foot)",
    "template_id": "94",
    "template": "4 client test NSW v2",
    "letterhead_id": "19",
    "letterhead": "bogan Test",
    "plan_claim_due_date": "10-10-2010",
    "comments": "<berich/><p style='margin-bottom:0px;margin-top:0px;padding-bottom:0px;padding-top:0px;'>1231 sdf</p>
              <p style='margin-bottom:0px;margin-top:0px;padding-bottom:0px;padding-top:0px;'><br>
              </p><p style='margin-bottom:0px;margin-top:0px;padding-bottom:0px;padding-top:0px;'>header</p>"
    "category_durability_enabled1": "No",
    "category_durability_enabled2": "No",
    "purchase_order": "10 PO Numbers",
    "purchase_order_id": 0,
    "show_revenue_centre": "Yes"
  }
  

6. Case outcomes (api1/cases/outcomes)

This method will answer with a collection of case outcomes. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

    [
        {
            "id": "126", //internal iinsight ID
            "name": "xxxx"
        },
        {
            "id": "594",
            "name": "xxxx"
        }
    ]
    

7. Update Status or Open/Close Case (api1/cases/status)

This method will allow to close a case in iinsight.

URL

Authorization

Query Params

Responses

    Simple Change Status
    {
      "case_id": "419",
      "case_status": "My Status"
    }

    Re-open creating a new case
    {
      "case_id": "419",
      "case_status": "Closed",
      "new_case_id": "655",
      "new_case_status": "Open"
    }

    Closing a case
    {
      "case_id": "419",
      "case_status": "Closed"
    } 
    

8. Update Case Details (api1/cases/details/update)

This method will allow to close a case in iinsight.

URL

Authorization

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

Response

    {
      "response": "Case Details updated",
      "case_id": "3"
    }
    

9. List service contracts (api1/cases/service_contracts)

This method will answer with a collection of service contracts. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

    [
      {
          "id": "174", //internal iinsight ID
          "name": "xxx"
      },
      {
          "id": "374",
          "name": "xxx"
      },
    ]
    

10. Update service contract (api1/cases/service_contracts/update)

This method will allow to update a case service contract.

URL

Authorization

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

Response

      {
        "respond": "Case Service Contract Updated.",
        "case_id": "174", 
        "service_contract_id": "11"
      }
    

11. Assign to case (api1/cases/assign)

This method will answer allow to assign a user to a case.

URL

Authorization

Query Params

Response

    {
      "respond": "User assinged to Case",
      "case_id": "2",
      "user_id": "172",
      "team_id": "4228"
    }
    

12. Case additional information (api1/cases/additional)

This method will answer of iinsight case addtional information.

URL

Authorization

Query Params

Response

    {
      "reason_for_referral_personal": "xxx",
      "reason_for_referral_work": "xxx",
      "doctor": "xxx",
      "doctor_prov_no": "xxx",
      "item": "xxx",
      "ethnicity": "xxx",
      "language": "xxx",
      "interpreter": "xxx",
      "gender": "xxx",
      "age": "##",
      "initial_contact_date": "dd-mm-yyyy",
      "initial_contact_time": "hh:mm am/pm",
      "appointment_date": "dd-mm-yyyy",
      "appointment_time": "hh:mm am/pm",
      "follow_up_date": "dd-mm-yyyy",
      "follow_up_time": "hh:mm am/pm",
      "authorised_by": "xxx",
      "participant_approved": "xxx",
      "funding_program": "xxx",
      "street": "xxx",
      "postcode": "xxx",
      "suburb": "xxx",
      "sublocality": "xxx",
      "state": "xxx",
      "country": "xxx",
      "latitude": "##.##",
      "longitude": "##.##",
      "care_of": "xxx",
    }
    

13. Update Case additional information (api1/cases/additional/update)

This method will allow to update case additional information.

URL

Authorization

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

Response

    {
      "respond": "Case additional information Updated.",
      "case_id": "2"
    }
    

14. Company case details (api1/cases/company)

This method will answer allow with a collection of Company Case details. The collection wil be in JSON format.

URL

Authorization

Query Params

Response

    {
      "company": "xxx",
      "title": "xx",
      "first_name": "xxx",
      "last_name": "xxx",
      "service_provided": "xxx",
      "position": "xxx",
      "department": "xxx",
      "deployment": "xxx",
      "phone1": "###",
      "phone2": "###",
      "fax": "###",
      "mobile": "###",
      "email": "###",
      "direction_id" : "2",
      "street": "# xxx xxx",
      "postcode": "###",
      "suburb": "xxx",
      "sublocality": xxx,
      "state": "xxx",
      "country": "xxx",
      "latitude": "###",
      "longitude": "###",
      "care_of": "xxx"
    }
    

15. Update Company case details (api1/cases/company/update)

This method will allow to update Company Case details.

URL

Authorization

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

Response

    {
      "respond": "Company case udpated",
      "case_id": "25"
    }
    

16. Check case n (api1/cases/check_case_n)

This method will answer allow to check if the giving case N exist or not for that business division.

URL

Authorization

Query Params

Response

    {
      "respond": "Case No already exist || Case No does not exist",
      "case_n": "25"
    }
    

17. Get max case n (api1/cases/max_case_n)

This method will answer with max case No + 1 of a Business division.

URL

Authorization

Query Params

Response

    {
      "respond": "Max case n",
      "case_n": "25"
    }
    

18. List Business Divisions (api1/cases/business_divisions)

This method will answer a collection of business divisions.

URL

Authorization

Query Params

Response

    [
      {
          "id": "174", //internal iinsight ID
          "name": "xxx"
      },
      {
          "id": "374",
          "name": "xxx"
      },
    ]
    

19. List Invoice Templates (api1/cases/invoice_templates)

This method will answer a collection of invoice templates.

URL

Authorization

Query Params

Response

    [
      {
          "id": "174", //internal iinsight ID
          "name": "xxx"
      },
      {
          "id": "374",
          "name": "xxx"
      },
    ]
    

20. New client Case (api1/cases/new_client)

This method will allow to create a new client/person case.

URL

Authorization

Query Params

Response

    {
      "response": "Case created successfully",
      "case_number": 1126,
      "case_n": "NSW2328"
    }
    

21. Get Case Alert (api1/cases/alert)

This method will answer a collection of case alert data.

URL

Authorization

Query Params

Response

    {
      "enable_case_alert": "Yes/No",
      "alert_message": "This is an Alert",
      "show_alert_in_case_list": "Yes/No",
      "show_alert_in_timesheets": "Yes/No",
      "show_alert_in_appointments": "Yes/No",
      "show_alert_in_mobileapp": "Yes/No",
      "is_disabled_for_today": "Yes/No"
    }
    

22. Disable Case Alert (api1/cases/alert/disable)

This method allows to disable a case Alert for the user.

URL

Authorization

Query Params

Response

    {
      "response": "Case Alert disabled for today",
      "case_id": "2",
      "user_id": "210"
    }
    

23. Find Cases Clients (api1/cases/search_by_client_name)

This method will answer with a collection of case clients data accessible for the logged in user. This is a searcher. The collection will be in JSON format.

URL

Authorization

Query Params

Response

      
[
      {
          "id": "607", // internal IInsight ID
          "case_number": "NSW169",
          "client_name": "adjustment test",
          "case_type": "1",
          "client_first_name": "adjustment",
          "client_last_name": "test",
          "client_company_name": "",
          "suburb": "",
          "date_opened": "1704801600",
          "date_of_birth": null,
          "case_status": "Open",
          "description": "Centrelink",
          "prefix": "NSW",
          "assigned_to": "admin admin"
      },
      {
          "id": "21",
          "case_number": "NSW11",
          "client_name": "Alexa Drummond",
          "case_type": "1",
          "client_first_name": "Alexa",
          "client_last_name": "Drummond",
          "client_company_name": "",
          "suburb": "Balmain",
          "date_opened": "1294621200",
          "date_of_birth": "42861600",
          "case_status": "Open",
          "description": "Xchanging",
          "prefix": "NSW",
          "assigned_to": "Renato Parletta"
      },
      {
          "id": "18",
          "case_number": "VIC5",
          "client_name": "Anita11 Allen",
          "case_type": "1",
          "client_first_name": "Anita11",
          "client_last_name": "Allen",
          "client_company_name": "",
          "suburb": "Chatswood",
          "date_opened": "1291597200",
          "date_of_birth": "626317200",
          "case_status": "Open",
          "description": "ADFRP1",
          "prefix": "VIC",
          "assigned_to": "Renato Parletta"
      },,
]
      
    

24. Get Client outstanding (api1/cases/client_outstanding)

This method will answer with client's outstanding.

URL

Authorization

Query Params

Response

    {
      "client_outstanding": "123.80"
    }
    

25. List Letterheads (api1/cases/letterheads)

This method will answer a collection of Letterheads.

URL

Authorization

Query Params

26. List Finance Templates (api1/cases/finance_templates)

This method will answer a collection of finance templates.

URL

Authorization

Query Params

Response

    [
      {
          "id": "174", //internal iinsight ID
          "name": "xxx"
      },
      {
          "id": "374",
          "name": "xxx"
      },
    ]