API version 1 Fields

1. List Field details (api1/fields)

This method will answer with a collection of iinsight's 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/api1/fields	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/fields	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

[  
    {
      "field": "field1" //name of the field 
      "container": 0, //the container or section of the UI
      "order": 0, // oder or index in the container
      "type": "field/label",
      "mandatory": "Yes/No",
      "enabled": "Yes/No",
      "label": "xxx", //label of the field
      "read_only": "Yes/No",
    },
    {
      "field": "field2"
      "container": 2,
      "order": 1,
      "type": "field/label",
      "mandatory": "Yes/No",
      "enabled": "Yes/No",
      "label": "xxx",
      "read_only": "Yes/No",
    }
]

2. List Custom Field details (api1/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/api1/fields/custom	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/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

[  
    {
      "custom_field_id": "253",
      "label": "test 1",
      "field_map_column": "custom_field_details.text_1_04",
      "enabled": "Yes",
      "mandatory": "No",
      "field_type_name": "Text",
      "container": 3,
      "order": 0,
      "list": "",
      "value": "test",
    },
    {
      "custom_field_id": "398",
      "label": "test dropdown",
      "field_map_column": "custom_field_details.select_1_20",
      "enabled": "No",
      "mandatory": "No",
      "field_type_name": "Dropdown", // options are Text, Dropdown, Checkbox, Multi-select Drop Down, Date, Time, Multicheckbox, Labels, Blanck Space, Multiline check box
      "container": 3,
      "order": 1,
      "default_value": {
            "default": "",
            "list": [
                {
                    "value": "Yes",
                    "text": "Yes"
                },
                {
                    "value": "No",
                    "text": "No"
                }
            ]
        },
      "value": "",
    },
    {
        "custom_field_id": "463",
        "label": "multicheck box",
        "field_map_column": "custom_field_details.multicheck_1_01",
        "enabled": "Yes",
        "mandatory": "No",
        "default_value": {
            "default": "",
            "type": "multi",
            "list": [
                {
                    "value": "1",
                    "text": "1"
                },
                {
                    "value": "2",
                    "text": "2"
                },
                {
                    "value": "3",
                    "text": "3"
                }
            ]
        },
        "field_type_name": "Multi Checkbox",
        "container": 3,
        "order": 59,
        "value": "1,2",
    }
]

3. List Support worker Fields (api1/fields/support_worker)

This method will answer with a collection of iinsight's fields that a support worker can access.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/fields/support_worker	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/fields/support_worker	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Response


      [
        "field1",
        "field2",
        "field3"
      ]