1. List existing fields (api2/fields/existing)
This method will answer with a collection of iinsight's existing fields and labels details to build the user interface for Case details, Client details, Aditional information and Contacts Tab. The collection will be in JSON format.
Note: this API requires customization of fields base on service contract feature on iisight
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-aus-uat.iinsightonline.com/api2/fields/existing |
GET |
| PRODUCTION |
https://api-aus.iinsightonline.com/api2/fields/existing |
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 |
| tab |
Tab name. Options: client, company, case, additional, contact |
Yes |
| case_id |
Case ID. (i.e.: 1) |
Yes |
| type |
Field type. (Options: all, enabled. Default all) |
No |
Response
{
"status": true,
"message": "Fields retrieved successfully",
"total_records": 42,
"data": [
{
"id": "100",
"name": "case_details.client_title",
"enabled": "Yes",
"mandatory": "No",
"label": "Title",
"type": "Dropdown",
"div_id": "CASE_DETAILS.CLIENT_TITLE_PERSON_DIV",
"container_id": "case_container_person1",
"default_label": "Title",
"container": "1",
"container_type": "existing",
"order": "0",
"field": "title"
},
{
"id": "97",
"name": "case_details.client_first_name",
"enabled": "Yes",
"mandatory": "Yes",
"label": "First Name",
"type": "Text",
"div_id": "CASE_DETAILS.CLIENT_FIRST_NAME_PERSON_DIV",
"container_id": "case_container_person1",
"default_label": "First Name",
"container": "1",
"container_type": "existing",
"order": "1",
"field": "first_name"
},
...
}
2. List Custom Fields (api2/fields/custom)
This method will answer with a collection of iinsight's custom fields and labels details. The collection will be in JSON format.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-aus-uat.iinsightonline.com/api2/fields/custom |
GET |
| PRODUCTION |
https://api-aus.iinsightonline.com/api2/fields/custom |
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 |
| tab |
Tab name. Obtions: client, company, case, additional, contact |
Yes |
| case_id |
Case ID. (i.e.: 1) |
Yes |
| contact_id |
Contact ID. (i.e.: 1) |
Yes if tab is contact |
| type |
Field type. (Options: all, enabled. Default all) |
No |
Response
{
"status": true,
"message": "Custom fields retrieved successfully",
"total_records": 71,
"data": [
{
"custom_field_id": "253",
"label": "Injury - Sustained",
"name": "custom_field_details.text_1_04",
"type": "Text",
"enabled": "No",
"mandatory": "No",
"default_value": "",
"container_id": "custom_fields_container1",
"container": "1",
"container_type": "custom",
"order": "0",
"field": "injury__sustained",
"value": ""
},
{
"custom_field_id": "359",
"label": "Test Dropdown",
"name": "custom_field_details.select_1_01",
"type": "Dropdown",
"enabled": "No",
"mandatory": "No",
"default_value": {
"default": "",
"list": [
{
"value": "Yes",
"text": "Yes"
},
{
"value": "No",
"text": "No"
}
]
},
"container_id": "custom_fields_container1",
"container": "1",
"container_type": "custom",
"order": "13",
"field": "test_dropdown",
"value": ""
},
...
}