NowCerts.com - REST API - Custom Fields

Insert new custom panels and fields (the structure)

 In the interface of NowCerts you can do this from the left main menu "Miscellaneous/Agency Customizations/Custom Fields".

1.    POST http://api.nowcerts.com/api/CustomPanel/Insert

 

This will insert only if there isn’t panel with same name in your account otherwise will make update on existing panel and insert newly created Custom Fields.

 The body need to be Collection of CustomPanels:

CustomFields_1.png

          Note: Name is Required

 

This will be your panel with a collection of Custom Fields.

CustomFields Collection:

CustomFields_2.png

             Note: Name is Required

Since this is collection you can have multiple custom fields in single panel. Every single Custom Field need to have proper Type.

CustomFieldType:

 CustomFields_3.png

Use only the Value we need integer representation of the type.

 

Example request with 2 CustomPanels:

[

  {

    "name": "Car",

    "description": "Car Panel",

    "customFields": [

      {

        "name": "Model",

        "description": "Car Model",

        "type": 0,

        "order": 1

      },

      {

        "name": "Engine",

        "description": "Car Engine",

        "type": 0,

        "order": 2

      },

      {

        "name": "Horse Power",

        "description": "Car Horse Power",

        "type": 1,

        "order": 3

      }

    ],

    "order": 1

  },

  {

    "name": "Car Rental",

    "description": "Car Rental Diary",

    "customFields": [

      {

        "name": "Car",

        "description": "Car Model",

        "type": 0,

        "order": 1

      },

      {

        "name": "Pick Up Date",

        "description": "Pick Up Date",

        "type": 4,

        "order": 2

      }

    ],

    "order": 2

  }

]

 

 

Insert new custom Field Values when Create new Insured

2.    POST http://api.nowcerts.com/api/Insured/Insert

 

Insured have collection of CustomFieldEdit object. This will insert value to existing Custom Panel and existing Custom Field. Note if we can’t find panel or field with name you present this method will not create panel and field. Use http://api.nowcerts.com/api/CustomPanel/Insert to create your panels first. 

The body need to be Collection of CustomFieldsEdit:

CustomFields_4.png

          Note: Every panel can have multiple custom fields.

This will be your panel with a collection of custom fields.

 

CustomFields Collection:

CustomFields_5.png

             Note: Value you want to store in existing Field

 

Since this is collection you can have multiple custom fields in single panel. Every single Custom Field need to have proper Value.

 

Example request with 2 CustomPanels:

"customFields": [

    {

      "custoPanelName": " Car Panel",

      "customFields": [

        {

          "customFieldName": "Model",

          "customFieldValue": "Ford Focus"

        },

        {

          "customFieldName": "Engine",

          "customFieldValue": "2.2"

        }

      ]

    },

    {

      "custoPanelName": "Car Rental",

      "customFields": [

        {

          "customFieldName": "Car Model",

          "customFieldValue": "Ford Mustang"

        },

        {

          "customFieldName": " Pick Up Date",

          "customFieldValue": "2018-11-14T10:22:52.7777825+02:00"

        }

      ]

    }

  ]

 

 

GET the created structure for Custom Panels and Fields

3.    GET http://api.nowcerts.com/api/CustomPanel/GetStructure

 

You can retrieve the structure of your Custom Panels and Fields using this method. Here's a link to the help page for the method:

https://api.nowcerts.com/Help/Api/GET-api-CustomPanel-GetStructure

The real friendly names of the panels and the fields are the ones our API is expecting when you use the Custom Fields in the method in 2. "Insured Insured".

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk