<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/customfields/{Id}Delete a custom fieldDelete a custom field for the currently logged in user, only administrators are allowed to delete custom fields.
DeleteCustomField Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesId of the custom field to delete
CustomFieldQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoCustom field id
CompanyIdformGuidNoReference to company that owns the custom field configuration
GroupIdformint?NoGroup id
FieldIdformintNoField id
NameformstringNoConfiguration name. Example: 'Number of persons'.
WidthformintNoField width. Example: 20
ColumnformstringNoColumn in database where to store the information. Example: 'TextField1'
DescriptionformstringNoCustom field description. Example: 'For how many persons is this booking?'
DataTypeformstringNoData field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
DefaultValueformstringNoDefault value of the field. Example: '3'
IsMandatoryformboolNoDetermines if the field is required to have a value or not
MandatoryErrorMessageformstringNoError message shown to the user if the field data is required but not entered
MaxLengthformintNoMax lenght of the field
MultipleLineTextformboolNoIf the field should have multiple lines
RegExformstringNoRegular expression used for validation of the field
RegExIdformint?NoRegular expression id for validation of the field
RegExErrorMessageformstringNoError message shown if the regular expression validation failed
IsPublicformboolNoIf the field is visible to the customer
IsHiddenformboolNoIf the field should be hidden in lists
TableformstringNoTable to which the field belongs
ValuesformList<CustomFieldLookupResponse>NoThe values to select from if Datatype is DropDown for this custom field
ServicesformList<CustomFieldServices>NoThe services that is connected to the custom field
CustomFieldLookupResponse Parameters:
NameParameterData TypeRequiredDescription
CustomFieldServices Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoName of the service
ImageUrlformUriNoThe image url of the service

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv


The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /customfields/{Id} HTTP/1.1 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

	Id: 0,
	GroupId: 0,
	FieldId: 0,
	Name: String,
	Width: 0,
	Column: String,
	Description: String,
	DataType: String,
	DefaultValue: String,
	IsMandatory: False,
	MandatoryErrorMessage: String,
	MaxLength: 0,
	MultipleLineText: False,
	RegEx: String,
	RegExId: 0,
	RegExErrorMessage: String,
	IsPublic: False,
	IsHidden: False,
	Table: String,
			Id: 0,
			Active: False,
			SortOrder: 0,
			Value: String
			Id: 0,
			Name: String