| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /customfields | Create a custom field | Creates a new custom field, if an admin user is making the request, the user will be associated with the admin user's company. |
|---|
export class CustomFieldLookupResponse
{
public Id?: number;
public Active?: boolean;
public SortOrder?: number;
public Value: string;
public constructor(init?: Partial<CustomFieldLookupResponse>) { (Object as any).assign(this, init); }
}
export class CustomFieldServices
{
public Id: number;
/** @description Name of the service */
// @ApiMember(Description="Name of the service")
public Name: string;
/** @description The image url of the service */
// @ApiMember(Description="The image url of the service")
public ImageUrl: string;
public constructor(init?: Partial<CustomFieldServices>) { (Object as any).assign(this, init); }
}
export class CustomFieldQueryResponse
{
/** @description Custom field id */
// @ApiMember(Description="Custom field id")
public Id: number;
/** @description Reference to company that owns the custom field configuration */
// @ApiMember(Description="Reference to company that owns the custom field configuration")
public CompanyId: string;
/** @description Group id */
// @ApiMember(Description="Group id")
public GroupId?: number;
/** @description Field id */
// @ApiMember(Description="Field id")
public FieldId: number;
/** @description Configuration name. Example: 'Number of persons'. */
// @ApiMember(Description="Configuration name. Example: 'Number of persons'.")
public Name: string;
/** @description Field width. Example: 20 */
// @ApiMember(Description="Field width. Example: 20")
public Width: number;
/** @description Column in database where to store the information. Example: 'TextField1' */
// @ApiMember(Description="Column in database where to store the information. Example: 'TextField1'")
public Column: string;
/** @description Custom field description. Example: 'For how many persons is this booking?' */
// @ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'")
public Description: string;
/** @description Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' */
// @ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
public DataType: string;
/** @description Default value of the field. Example: '3' */
// @ApiMember(Description="Default value of the field. Example: '3'")
public DefaultValue: string;
/** @description Determines if the field is required to have a value or not */
// @ApiMember(Description="Determines if the field is required to have a value or not")
public IsMandatory: boolean;
/** @description Error message shown to the user if the field data is required but not entered */
// @ApiMember(Description="Error message shown to the user if the field data is required but not entered")
public MandatoryErrorMessage: string;
/** @description Max lenght of the field */
// @ApiMember(Description="Max lenght of the field")
public MaxLength: number;
/** @description If the field should have multiple lines */
// @ApiMember(Description="If the field should have multiple lines")
public MultipleLineText: boolean;
/** @description Regular expression used for validation of the field */
// @ApiMember(Description="Regular expression used for validation of the field")
public RegEx: string;
/** @description Regular expression id for validation of the field */
// @ApiMember(Description="Regular expression id for validation of the field")
public RegExId?: number;
/** @description Error message shown if the regular expression validation failed */
// @ApiMember(Description="Error message shown if the regular expression validation failed")
public RegExErrorMessage: string;
/** @description If the field is visible to the customer */
// @ApiMember(Description="If the field is visible to the customer")
public IsPublic: boolean;
/** @description If the field should be hidden in lists */
// @ApiMember(Description="If the field should be hidden in lists")
public IsHidden: boolean;
/** @description Table to which the field belongs */
// @ApiMember(Description="Table to which the field belongs")
public Table: string;
/** @description The values to select from if Datatype is DropDown for this custom field */
// @ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")
public Values: CustomFieldLookupResponse[];
/** @description The services that is connected to the custom field */
// @ApiMember(Description="The services that is connected to the custom field")
public Services: CustomFieldServices[];
public constructor(init?: Partial<CustomFieldQueryResponse>) { (Object as any).assign(this, init); }
}
export class CustomFieldGroupValue
{
public SortOrder?: number;
public Value: string;
public constructor(init?: Partial<CustomFieldGroupValue>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateCustomField implements ICompany
{
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public CompanyId?: string;
/** @description Field id */
// @ApiMember(Description="Field id")
public FieldId: number;
/** @description Configuration name. Example: 'Number of persons'. */
// @ApiMember(Description="Configuration name. Example: 'Number of persons'.", IsRequired=true)
public Name: string;
/** @description Custom field description. Example: 'For how many persons is this booking?' */
// @ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'", IsRequired=true)
public Description: string;
/** @description Custom field icon id. Example: '1 House,2 Calendar,3 Building,4 Cart,5 Find,6 Blue flag,7 Green flag,8 Information,9 Lightning,10 Page edit,11 Pencil,12 Link,13 Star,14 User,15 Tick,16 Wrench,17 Clock' */
// @ApiMember(Description="Custom field icon id. Example: '1 House,2 Calendar,3 Building,4 Cart,5 Find,6 Blue flag,7 Green flag,8 Information,9 Lightning,10 Page edit,11 Pencil,12 Link,13 Star,14 User,15 Tick,16 Wrench,17 Clock'", IsRequired=true)
public IconId: number;
/** @description Field width. Example: 20 */
// @ApiMember(Description="Field width. Example: 20")
public Width: number;
/** @description Data field of custom field. Valid values are: TextBox, DropDown Example: 'TextBox' */
// @ApiMember(Description="Data field of custom field. Valid values are: TextBox, DropDown Example: 'TextBox'")
public Datatype: string;
/** @description Default value of the field. Example: '3' */
// @ApiMember(Description="Default value of the field. Example: '3'")
public DefaultValue: string;
/** @description Determines if the field is required to have a value or not. Default is false */
// @ApiMember(Description="Determines if the field is required to have a value or not. Default is false")
public IsMandatory: boolean;
/** @description Error message shown to the user if the field data is required but not entered */
// @ApiMember(Description="Error message shown to the user if the field data is required but not entered")
public MandatoryErrorMessage: string;
/** @description Max lenght of the field. Default is 500 */
// @ApiMember(Description="Max lenght of the field. Default is 500", IsRequired=true)
public MaxLength: number;
/** @description If the field should have multiple lines. Defualt is false */
// @ApiMember(Description="If the field should have multiple lines. Defualt is false")
public MultipleLineText: boolean;
/** @description Regular expression used for validation of the field */
// @ApiMember(Description="Regular expression used for validation of the field")
public RegExId?: number;
/** @description Error message shown if the regular expression validation failed */
// @ApiMember(Description="Error message shown if the regular expression validation failed")
public RegExErrorMessage: string;
/** @description If the field is visible to the customer. Default is true */
// @ApiMember(Description="If the field is visible to the customer. Default is true")
public IsPublic: boolean;
/** @description If the field should be hidden in lists. Default is false */
// @ApiMember(Description="If the field should be hidden in lists. Default is false")
public IsHidden: boolean;
/** @description The values to select from if Datatype is DropDown for this custom field */
// @ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")
public Values: CustomFieldGroupValue[];
/** @description The services that is connected to the custom field. If null it will be connected to all services. */
// @ApiMember(Description="The services that is connected to the custom field. If null it will be connected to all services.")
public Services: CustomFieldServices[];
public constructor(init?: Partial<CreateCustomField>) { (Object as any).assign(this, init); }
}
TypeScript CreateCustomField DTOs
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.
POST /customfields HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
FieldId: 0,
Name: String,
Description: String,
IconId: 0,
Width: 0,
Datatype: String,
DefaultValue: String,
IsMandatory: False,
MandatoryErrorMessage: String,
MaxLength: 0,
MultipleLineText: False,
RegExId: 0,
RegExErrorMessage: String,
IsPublic: False,
IsHidden: False,
Values:
[
{
SortOrder: 0,
Value: String
}
],
Services:
[
{
Id: 0,
Name: String
}
]
}
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,
Values:
[
{
Id: 0,
Active: False,
SortOrder: 0,
Value: String
}
],
Services:
[
{
Id: 0,
Name: String
}
]
}