REI Software

REI Software Help Library

Search for any help questions or topics.

Custom Field API

O
Orlando
Updated 3 years ago

Custom Field

 

GET/v1/custom-fields/

https://rest.reisoftware.com/v1/custom-fields/

Get all available custom fields.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/custom-fields/' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "customFields": [

    {

      "id": "ocQHyuzHvysMo5N5VsXc",

      "name": "Select",

      "fieldKey": "contact.select",

      "placeholder": "Placeholder Text",

      "position": 0,

      "dateType": "SINGLE_OPTIONS",

      "picklistOptions": [

        "first",


POST/v1/custom-fields/

https://rest.reisoftware.com/v1/custom-fields/

Creating Custom Field.

Data Type Fields will allow these options. ex:

Options:



  • TEXT

  • LARGE_TEXT

  • NUMERICAL

  • PHONE

  • MONETORY

  • CHECKBOX

  • SINGLE_OPTIONS

  • MULTIPLE_OPTIONS

  • FLOAT

  • TIME

  • DATE

  • TEXTBOX_LIST

  • FILE_UPLOAD

  • SIGNATURE



Validation:

Name and Date Type are required to create every custom field.

On every data type of field have diffrent validation rules. These are the different validation rules.

FILE_UPLOAD:



  • acceptedFormat *(required) This will allow array of file format.



  • .pdf

  • .docx

  • .jpeg

  • .png

  • .gif

  • .csv

  • all



  • isMulitpalFile (optional) it allow true or false. If you want to allow multipal files pass true

  • maxNumberOfFiles (options) It will allow maximum these number of files.

SINGLE_OPTIONS / MULTIPLE_OPTIONS / CHECKBOX:


  • options *(required) This will allow array of options.

TEXTBOX_LIST


  • textBoxListOptions: (required) This will allow array of textbox list. Array will contanis label and prefillValue. ex.: {label": "Hello", "prefillValue": "value"}




Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

BODYraw

View More

{

    "name": "Custom Field",

    "dataType": "TEXT",

    "placeholder": "Placeholder Text",

    "options": [

        "first option",

        "last option"

    ],

    "acceptedFormat": [

        ".pdf",

        ".docx",

 

 

Successful response

Example Request

View More

curl --location --request POST 'https://rest.reisoftware.com/v1/custom-fields/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "name": "Custom Field",

    "dataType": "TEXT",

    "placeholder": "Placeholder Text",

    "options": [

        "first option",

        "last option"

    ],

    "acceptedFormat": [

Example Response

200 OK

BodyHeader(1)

View More

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "contact.select",

  "placeholder": "Placeholder Text",

  "position": 0,

  "dateType": "SINGLE_OPTIONS",

  "picklistOptions": [

    "first",

    "first"

  ]

GET/v1/custom-fields/:customFieldId

https://rest.reisoftware.com/v1/custom-fields/:customFieldId

Get custom fields by id

Authorization:

Provide your location api key (Bearer Token).  


AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

customFieldId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Field Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/custom-fields/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "contact.select",

  "placeholder": "Placeholder Text",

  "position": 0,

  "dateType": "SINGLE_OPTIONS",

  "picklistOptions": [

    "first",

    "first"

  ]

PUT/v1/custom-fields/:customFieldId

https://rest.reisoftware.com/v1/custom-fields/:customFieldId

Updating Custom Field.

Data Type Fields will allow these options. ex:

Options:



  • TEXT

  • LARGE_TEXT

  • NUMERICAL

  • PHONE

  • MONETORY

  • CHECKBOX

  • SINGLE_OPTIONS

  • MULTIPLE_OPTIONS

  • FLOAT

  • TIME

  • DATE

  • TEXTBOX_LIST

  • FILE_UPLOAD

  • SIGNATURE



Validation:

Name and Date Type are required to create every custom field.

On every data type of field have diffrent validation rules. These are the different validation rules.

FILE_UPLOAD:



  • acceptedFormat *(required) This will allow array of file format.



  • .pdf

  • .docx

  • .jpeg

  • .png

  • .gif

  • .csv

  • all



  • isMulitpalFile (optional) it allow true or false. If you want to allow multipal files pass true

  • maxNumberOfFiles (options) It will allow maximum these number of files.



SINGLE_OPTIONS / MULTIPLE_OPTIONS / CHECKBOX:



  • options *(required) This will allow array of options.



TEXTBOX_LIST




  • textBoxListOptions: (required) This will allow array of textbox list. Array will contanis label and prefillValue. ex.: {label": "Hello", "prefillValue": "value"}




Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

customFieldId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Field Id

BODYraw

View More

{

    "name": "Custom Field",

    "dataType": "TEXT",

    "placeholder": "Placeholder Text",

    "options": [

        "first option",

        "last option"

    ],

    "acceptedFormat": [

        ".pdf",

        ".docx",

 

 

Successful response

Example Request

View More

curl --location --request PUT 'https://rest.reisoftware.com/v1/custom-fields/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "name": "Custom Field",

    "dataType": "TEXT",

    "placeholder": "Placeholder Text",

    "options": [

        "first option",

        "last option"

    ],

    "acceptedFormat": [

Example Response

200 OK

BodyHeader(1)

View More

{

  "id": "ocQHyuzHvysMo5N5VsXc",

  "name": "Select",

  "fieldKey": "contact.select",

  "placeholder": "Placeholder Text",

  "position": 0,

  "dateType": "SINGLE_OPTIONS",

  "picklistOptions": [

    "first",

    "first"

  ]

DEL/v1/custom-fields/:customFieldId

https://rest.reisoftware.com/v1/custom-fields/:customFieldId

Delete one of custom fields.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

customFieldId

ocQHyuzHvysMo5N5VsXc

(Required) Custom Field Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/custom-fields/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""





😞 😐 😃