Manual i-Reserve - API - Config GET config/custfields

Home Functional information Available API's API-Config

Documentation

Difficulty level:

GET config/custfields

Used for

Getting the configuration for customer fields. Output is determined on the current user. Anonymous user request is possible. In that case default settings will be send. Therefore it is recommended to login via user api.

Authentication

Anonymous or user.

Parameters

Parameter	Description	Required	Example
lang		No	dutch

Output

Parameter	Description	Example
name	The name of the field	dutch
type	1=Mandatory, 2=Optional	1
checks	Optional regular expression	To check postal: ^[0-9]{4}[ ]{0,1}[A-Z]{2}$"
length	The length of the text field	20
ct_type	Custom table field type
ct_field	Custom table field name
display	The display value	E-mail

Response codes

200 OK

Example

Getting the configuration for customer fields.

GET api/rest/config/custfields

Response: 
[
  {
    "name": "email",
    "type": "1",
    "checks": "^ *[",
    "length": "30",
    "ct_type": "",
    "ct_field": "",
    "display": "E-mail"
  },
  {
    "name": "initials",
    "type": "2",
    "checks": "",
    "length": "8",
    "ct_type": "",
    "ct_field": "",
    "display": "Voornaam"
  }
]