iinsight | Developer portal
www.iinsight.biz

API version 2 Case

1. List Cases (api2/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
Server URL HTTP type
UAT https://api-usa-uat.iinsightonline.com/api2/cases GET
PRODUCTION https://api-usa.iinsightonline.com/api2/cases GET
Authorization
Parameter Value Mandatory
Type Bearer Token Yes
Token The token is generated using the /auth/login method Yes
Query Params
Parameter Value Mandatory
fields Contacs fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...) Yes
status Filter by contact status. Options: all, closed, opened, assigned, assigned_open, team No
sort_col Sort by column field name. (i.e.: field_name) No
sort_type Sort column type. Options: asc, desc No
search_criteria Search criteria in json format (i.e.: {"field_name1":"value1","field_name2":"value2,value3"}) No
page The page number of the paginated results. (i.e.: 1) No
limit The limit amount of items. (i.e.: 1) No
Response

  {
    "status": true,
    "displayed_records": 60,
    "total_records": "664",
    "data": [
        {
            "case_number": "1017",
            "is_archived": "0",
            "service_contract_id": "374",
            "case_status": "",
            "case_type": "client",
            "case_status_color": "59ba57",
            "durability_date1": null,
            "durability_outcome1": null,
            "durability_reminder1": "0",
            "category_durability_enabled1": "1",
            "category_durability_reminder1": "13",
            "date_closed": "0",
            "durability_date2": null,
            "durability_outcome2": null,
            "durability_reminder2": "0",
            "category_durability_enabled2": "1",
            "category_durability_reminder2": "26",
            "employer": "EMLl"
        },
        ...
        ]
}

2. Update Client Information (api2/cases/client/update)

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

URL
Server URL HTTP type
UAT https://api-usa-uat.iinsightonline.com/api2/cases/client/update PUT
PRODUCTION https://api-usa.iinsightonline.com/api2/cases/client/update PUT
Authorization
Parameter Value Mandatory
Type Bearer Token Yes
Token The token is generated using the /auth/login method Yes
Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)
Parameter Value Mandatory
case_id Case ID. (i.e.: 1017) Yes
title Client's title (i.e.: Ms). No
first_name Client's first name. No
last_name Client's last name. No
dob Date of birth. (i.e.: 12-06-1996) No
phone1 Client's primary phone. No
phone2 Client's secondary phone. No
fax Client's fax number. No
mobile Client's mobile phone. No
email Client's email. (i.e.: paul.lee@example.com) No
street Client's street address. No
postcode Client's postcode. No
suburb Client's suburb. No
sublocality Client's sublocality. No
state Client's state. No
country Client's country. No
latitude Client's latitude. No
longitude Client's longitude. No
care_of Care of (i.e.: SarahLee). No
medicare_no Medicare number. No
medicare_irn Medicare individual reference number. No
medicare_expiry_date Medicare expiry date. No
primary_physical_claim Primary physical claim. No
primary_psychological_claim Primary psychological claim. No
nature_of_condition Nature of condition. No
diagnosed_condition Diagnosed condition. No
cause Cause of incident. No
occurred Date of occurrence. (i.e.: 10-11-2023) No
incident_street Incident street. No
incident_postcode Incident postcode. No
incident_suburb Incident suburb. No
incident_sublocality Incident sublocality. No
incident_state Incident state. No
incident_country Incident country. No
incident_latitude Incident latitude. No
incident_longitude Incident longitude. No
client_current_work_status Current work status. No
position Client's position. No
department Client's department. No
deployment Client's deployment. No
employer_id Employer ID. No
employer_segment Employer segment. No
custom_fields JSON array of custom fields. No
Response

  {
    "response": "Client details updated",
    "case_id": "1017",
    "updated_data": {
        "title": "Ms",
        "first_name": "paul",
        "last_name": "lee",
        "date_of_birth": "12-06-1996",
        "phone1": "6441111",
        "phone2": "75122222",
        "fax": "09443300",
        "mobile": "061234567",
        "email": "paul.lee@example.com",
        "direction_id": "833",
        "street": "123KingStreet",
        "postcode": "M5V2N8",
        "suburb": "Toronto",
        "sublocality": "Downtown",
        "state": "ON",
        "country": null,
        "latitude": "43.65107",
        "longitude": "-79.347015",
        "care_of": "SarahLee",
        "medicare_no": "77777778",
        "medicare_irn": "35",
        "medicare_date": "01-09-2025",
        "primary_physical_claim": "No",
        "primary_psychological_claim": "Yes",
        "nature_of_condition": "HerniatedDisc",
        "diagnosed_condition": "BackInjury",
        "cause": "CarAccident",
        "occurred": "10-11-2023",
        "incident_direction_id": "834",
        "incident_street": "22WellingtonStreet",
        "incident_postcode": "K1A0B1",
        "incident_suburb": "Ottawa",
        "incident_sublocality": "Centretown",
        "incident_state": "ON",
        "incident_country": "Canada",
        "incident_latitude": "45.4215",
        "incident_longitude": "-75.6972",
        "incident_care_of": "JessicaBrown",
        "client_current_work_status": "Unemployed",
        "position": "ContentStrategist",
        "department": "Marketing",
        "deployment": "Hybrid",
        "employer_company_id": "14",
        "employer_id": "30",
        "employer": "Commerce Bank",
        "employer_segment": "TechIndustry",
        "pre_condition_hours": "50",
        "hours_stated_at_referral": "100",
        "current_hours_stated": "30",
        "certified_hours": "40",
        "notional_weekly_earnings": "1800.00",
        "earnings_at_referral": "1200.00",
        "current_earnings": "1500.00",
        "current_earnings_from": "10-02-2025",
        "suitable_employment_goal": "CareerAdvancement",
        "kin_first_name": "MarkJ.",
        "kin_last_name": "Lee",
        "kin_relationship": "Father",
        "kin_mobile": "0612345678",
        "kin_phone": "042345-6789",
        "kin_email": "mark.lee@example.com",
        "age": "28 years"
    },
    "updated_custom_fields": [
        {
            "field": "custom_field_details.text_1_04",
            "input_value": "zed",
            "current_value": "zed o no zed",
            "status": "Updated"
        },
        {
            "field": "custom_field_details.multicheck_1_01",
            "input_value": "Value 2",
            "current_value": "Value 2",
            "status": "Unchanged"
        },
        {
            "field": "custom_field_details.multicheck_1_02",
            "input_value": "test aA",
            "current_value": "test aA,test bB",
            "status": "Updated"
        },
        {
            "field": "custom_field_details.select_1_03",
            "input_value": "Value 1",
            "current_value": "Value 1",
            "status": "Unchanged"
        },
        {
            "field": "custom_field_details.time_1_01",
            "input_value": 540,
            "current_value": "540",
            "status": "Unchanged"
        }
    ]
}

3. Update Case Details (api2/cases/details/update)

This method will allow to close a case in iinsight.

URL
Server URL HTTP type
UAT https://api-usa-uat.iinsightonline.com/api2/cases/details/update PUT
PRODUCTION https://api-usa.iinsightonline.com/api2/cases/details/update PUT
Authorization
Parameter Value Mandatory
Type Bearer Token Yes
Token The token is generated using the /auth/login method Yes
Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)
Parameter Value Mandatory
case_id Case ID. (i.e.: 1) Yes
referrer_id Referrer ID. (i.e.: 1) No
referred_on Referral date. (i.e.: ##-##-####) No
acceptance_date Acceptance Date. (i.e.: ##-##-####) No
date_ceased_work Date ceased work. (i.e.: ##-##-####) No
case_detailscpc_date Current progress codes Date. (i.e.: ##-##-####) No
case_detailsccc_date Current closure codes Date. (i.e.: ##-##-####) No
date_suspended Suspended date. (i.e.: ##-##-####) No
bill_to_id Bill to ID. (i.e.: 1) No
opened_on Date opened. (i.e.: ##-##-####) No
notification Date of notification. (i.e.: ##-##-####) No
service_contract_id Service contract ID. (i.e.: 1) No
team_id Team ID. (i.e.: 1) No
claim_plan_due_date Plan Claim due Date. (i.e.: ##-##-####) No
durability_date1 Durability date 1. (i.e.: ##-##-####) No
durability_date2 Durability date 2. (i.e.: ##-##-####) No
durability_reminder1 Durability reminder 1. (Options: Yes|No) No
durability_reminder2 Durability reminder 2. (Options: Yes|No) No
template_id Invoice template ID. (i.e.: 1) No
letterhead_id Letterhead ID. (i.e.: 1) No
custom_fields An array of Custom fields in JSON format. (i.e.: [{"field":"custom_field_details.text_1_01","value":"test"}, {"field":"custom_field_details.text_1_02","value":"test2"}]) No
Response

{
    "status": true,
    "response": "Case Details Updated",
    "case_id": "1010",
    "updated_data": {
        "case_number": "1010",
        "case_n": "1",
        "office_id": "1",
        "prefix": "Nat",
        "reason_for_referral": "",
        "referral_category": "",
        "referrer_id": "0",
        "referrer": null,
        "referrer_company_id": null,
        "referral_id": null,
        "referral_type": null,
        "referred_on": "22-11-2022",
        "acceptance_date": "22-11-2022",
        "delay_to_commencement": "",
        "client_status_prior_to_referral": "",
        "client_status_referral": "",
        "client_status_at_case_closure": "",
        "referral_source": "",
        "date_ceased_work": "",
        "last_progress_codes": "",
        "last_progress_code_date": "",
        "current_progress_codes": "",
        "current_progress_codes_date": "",
        "last_closure_codes": "",
        "last_closure_codes_date": "",
        "current_closure_codes": "",
        "current_closure_codes_date": "",
        "case_status": "Closed",
        "risk_category": null,
        "date_closed": "22-01-2025",
        "case_duration": "1348772",
        "bill_to_id": "674",
        "bill_to": "Software Testing Company",
        "bill_to_company_id": "285",
        "date_opened": "22-11-2022",
        "date_reopened": "",
        "date_of_notification": "22-11-2022",
        "internal_case_no": "",
        "biller_code": "",
        "claim_no": "",
        "participant_no": null,
        "business_unit_name": "",
        "task_ref_no": "",
        "contract_no": "",
        "outcome": "Program completed no return to work",
        "durability_outcome1": null,
        "durability_date1": "",
        "durability_outcome2": null,
        "durability_date2": null,
        "durability_reminder1": "Yes",
        "durability_reminder2": "Yes",
        "date_suspended": "",
        "assigned_to_id": "157",
        "assigned_to": "Raju Kumar",
        "service_contract_id": "35",
        "service_contract": "Nat:Workcover",
        "additional_referral_particulars": "",
        "team_id": "4229",
        "team": "QA Team",
        "revenue_centre_id": null,
        "revenue_centre": null,
        "template_id": null,
        "template": null,
        "letterhead_id": null,
        "letterhead": null,
        "plan_claim_due_date": "",
        "comments": "",
        "category_durability_enabled1": "No",
        "category_durability_enabled2": "No",
        "purchase_order": "",
        "purchase_order_id": 0,
        "show_revenue_centre": "Yes"
    },
    "updated_custom_fields": [
        {
            "field": "custom_field_details.chk_3_01",
            "input_value": "2",
            "current_value": "1",
            "status": "Updated"
        },
        {
            "field": "custom_field_details.date_3_02",
            "input_value": 539956800,
            "current_value": "539956800",
            "status": "Unchanged"
        },
        {
            "field": "custom_field_details.text_3_05",
            "input_value": "anything",
            "current_value": "something",
            "status": "Updated"
        }
    ]
}

4. Update Case additional information (api2/cases/additional/update)

This method will allow to update case additional information.

URL
Server URL HTTP type
UAT https://api-usa-uat.iinsightonline.com/api2/cases/additional/update PUT
PRODUCTION https://api-usa.iinsightonline.com/api2/cases/additional/update PUT
Authorization
Parameter Value Mandatory
Type Bearer Token Yes
Token The token is generated using the /auth/login method Yes
Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)
Parameter Value Mandatory
case_id Case ID. (e.g., 1) Yes
reason_for_referral_personal Reason for referral (personal). (e.g., Anxiety Counselling) No
reason_for_referral_work_related Reason for referral (work-related). (e.g., Stress at Work) No
doctor_name Doctor's name. (e.g., Dr. Smith) No
provno Doctor's provider number. (e.g., 12345) No
item Item description. (e.g., General Consultation) No
ethnicity Client's ethnicity. (e.g., Caucasian) No
preferred_language Client's preferred language. (e.g., Spanish) No
interpreter_required Is an interpreter required? (e.g., Yes/No) No
gender Client's gender. (e.g., Male) No
age_range Client's age range. (e.g., 25-30) No
initial_contact_date Initial contact date. (e.g., dd-mm-yyyy) No
initial_contact_time Initial contact time. (e.g., hh:mm am/pm) No
appointment_date Appointment date. (e.g., dd-mm-yyyy) No
appointment_time Appointment time. (e.g., hh:mm am/pm) No
follow_up_date Follow-up contact date. (e.g., dd-mm-yyyy) No
follow_up_time Follow-up contact time. (e.g., hh:mm am/pm) No
authorised_by Authorisation by. (e.g., Admin) No
inkind_funding_program Funding program. (e.g., Government Health Fund) No
participant_approved Participant approval status. (e.g., Approved/Rejected) No
street Client's street address. (e.g., 606 Liverpool Road) No
postcode Client's postcode. (e.g., 2136) No
suburb Client's suburb. (e.g., Strathfield) No
sublocality Client's sublocality. (e.g., Municipality of Strathfield) No
state Client's state. (e.g., New South Wales) No
country Client's country. (e.g., Australia) No
latitude Client's latitude coordinate. (e.g., -33.8688) No
longitude Client's longitude coordinate. (e.g., 151.2093) No
care_of Care of address. (e.g., John Doe) No
custom_fields An array of custom fields in JSON format. (e.g., [{"field":"custom_field_details.text_1_01","value":"test"}]) No
Response

  {
    "response": "Case additional information Updated.",
    "case_id": "3",
    "updated_custom_fields": [
        {
            "field": "custom_field_details.text_4_02",
            "input_value": "test marc2",
            "current_value": "",
            "status": "Updated"
        }
    ]
}

5. Update Company case details (api2/cases/company/update)

This method will allow to update Company Case details.

URL
Server URL HTTP type
UAT https://api-usa-uat.iinsightonline.com/api2/cases/company/update PUT
PRODUCTION https://api-usa.iinsightonline.com/api2/cases/company/update PUT
Authorization
Parameter Value Mandatory
Type Bearer Token Yes
Token The token is generated using the /auth/login method Yes
Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)
Parameter Value Mandatory
case_id Case ID. (i.e.: 1) Yes
company Company name. (i.e.: Remington) No
title Client title. (i.e.: Mr) No
first_name Client first name. (i.e.: Jenny) No
last_name Client last name. (i.e.: Generic) No
service_provided Services provided to. (i.e.: Generic) No
position Client position. (i.e.: Accounts) No
deployment Deployment/Assignment. (i.e.: Generic) No
phone1 Client phone 1. (i.e.: 123) No
phone2 Client phone 2. (i.e.: 123) No
fax Client fax. (i.e.: 123) No
mobile Client mobile. (i.e.: 123) No
email Client email. (i.e.: generic@mail.com) No
street Client street address. (i.e.: 606 Liverpool Road) No
postcode Client postcode address. (i.e.: 2136) No
suburb Client suburb address. (i.e.: Generic) No
sublocality Client sublocality address. (i.e.: Municipality of Strathfield) No
state Client state address. (i.e.: New South Wales) No
country Client country address. (i.e.: Sydney) No
latitude Client latitude address. (i.e.: 1) No
longitude Client longitude address. (i.e.: 1) No
care_of Care of address (i.e.: Generic) No
custom_fields An array of Custom fields in JSON format. No
Response
{
    "response": "Company case udpated",
    "case_id": "27",
    "updated_custom_fields": [
        {
            "field": "custom_field_details.chk_2_01",
            "input_value": "2",
            "current_value": "1",
            "status": "Updated"
        },
        {
            "field": "custom_field_details.text_2_02",
            "input_value": "some",
            "current_value": "zed",
            "status": "Updated"
        },
        {
            "field": "custom_field_details.select_2_01",
            "input_value": "AAA1",
            "current_value": "AAA1",
            "status": "Unchanged"
        }
    ]
}