BokaMera.API.Host

CreateCustomer

**Requires Authentication**
Required role:	bookingsupplier-administrator-write

The following routes are available for this service:
POST	/customers	Create a new customer	Creates a new customer, if an admin user is making the request, the user will be associated with the admin user's company.

**CreateCustomer** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	Enter the company and id for the customer, if blank company id and you are an admin, your company id will be used.
CustomFields	body	List<AddCustomField>	Yes	If Custom Fields are added to the customer, here you will send the id and the value for each custom field to be updated
AccessKeys	body	List<AddUserAccessKey>	Yes	List of Access Keys
InvoiceAddress	body	InvoiceAddressToHandle	Yes	Customer invoice adress

**CustomerBase** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	Guid?	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
Phone	form	string	Yes
SubscribedToNewsletter	form	bool	No

**AddCustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Value	form	string	Yes

**AddUserAccessKey** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid?	No	Specify 'Id' to update an existing access key, leave empty to create a new one
CompanyId	form	Guid?	No	The company ID associated with this access key
AccessKeyTypeId	form	int	No	The type of access key to create
Value	form	string	Yes	The actual key value or token
CustomerId	form	Guid?	No	The customer ID this access key is associated with
Description	form	string	Yes	A description or note about this access key

**InvoiceAddressToHandle** Parameters:
Name	Parameter	Data Type	Required
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**UpdateCustomerResponse** Parameters:
Name	Parameter	Data Type	Required
FacebookUserName	form	string	Yes
UserId	form	Guid?	No
CompanyId	form	Guid?	No
CreatedDate	form	DateTime?	No
DeletedAccessKeys	form	List<UserAccessKeys>	Yes
CreatedOrUpdatedAccessKeys	form	List<UserAccessKeys>	Yes

**CustomerQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
Phone	form	string	Yes
ImageUrl	form	string	Yes
CustomFields	form	List<CustomFieldConfigData>	Yes
CustomFieldValues	form	List<CustomFieldDataResponse>	Yes
Comments	form	List<CustomerCommentsResponse>	Yes
AccessKeys	form	List<UserAccessKeys>	Yes
Updated	form	DateTime	No
Created	form	DateTime	No
ResponseStatus	form	Object	Yes
SubscribedToNewsletter	form	bool	No
InvoiceAddress	form	InvoiceAddressResponse	Yes

**CustomFieldConfigData** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	Custom field id
Name	form	string	Yes	Configuration name. Example: 'Number of persons'.
Description	form	string	Yes	Custom field description. Example: 'For how many persons is this booking?'
Width	form	int?	No	Field width. Example: 20 for 20px
DataType	form	string	Yes	Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
DefaultValue	form	string	Yes	Default value of the field. Example: '3'
IsMandatory	form	bool	No	Determines if the field is required to have a value or not
MandatoryErrorMessage	form	string	Yes	Error message shown to the user if the field data is required but not entered
MaxLength	form	int	No	Max lenght of the field
MultipleLineText	form	bool	No	If the field should have multiple lines
RegEx	form	string	Yes	Regular expression used for validation of the field
RegExErrorMessage	form	string	Yes	Error message shown if the regular expression validation failed
Values	form	List<CustomFieldValueResponse>	Yes	The values to select from if Datatype is DropDown for this custom field

**CustomFieldValueResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	Yes

**CustomFieldDataResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Column	form	string	Yes
Name	form	string	Yes
Description	form	string	Yes
Value	form	string	Yes
DataType	form	string	Yes	Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'

**CustomerCommentsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CustomerId	form	Guid	No
Comments	form	string	Yes
Updated	form	DateTime	No
Created	form	DateTime	No
ImageUrl	form	Uri	Yes

**UserAccessKeys** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	Yes
AccessKeyTypeId	form	int	Yes
Value	form	string	Yes
CustomerId	form	Guid	Yes
Description	form	string	No
Id	form	Guid	Yes

**InvoiceAddressResponse** Parameters:
Name	Parameter	Data Type	Required
InvoiceAddressId	form	Guid	No
UserId	form	Guid?	No
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

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

HTTP + JSV

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

POST /customers HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	CustomFields: 
	[
		{
			Id: 0,
			Value: String
		}
	],
	AccessKeys: 
	[
		{
			Id: 00000000-0000-0000-0000-000000000000,
			CompanyId: 00000000-0000-0000-0000-000000000000,
			AccessKeyTypeId: 0,
			Value: String,
			CustomerId: 00000000-0000-0000-0000-000000000000,
			Description: String
		}
	],
	InvoiceAddress: 
	{
		CorporateIdentityNumber: String,
		InvoiceAddress1: String,
		InvoiceAddress2: String,
		InvoiceCity: String,
		InvoicePostalCode: String,
		InvoiceCountryCode: String
	},
	CustomerId: 00000000-0000-0000-0000-000000000000,
	Firstname: String,
	Lastname: String,
	Email: String,
	Phone: String,
	SubscribedToNewsletter: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FacebookUserName: String,
	UserId: 00000000-0000-0000-0000-000000000000,
	CompanyId: 00000000-0000-0000-0000-000000000000,
	CreatedDate: "0001-01-01T00:00:00",
	DeletedAccessKeys: 
	[
		{
			AccessKeyTypeId: 0,
			Value: String,
			Description: String
		}
	],
	CreatedOrUpdatedAccessKeys: 
	[
		{
			AccessKeyTypeId: 0,
			Value: String,
			Description: String
		}
	],
	Firstname: String,
	Lastname: String,
	Email: String,
	Phone: String,
	ImageUrl: String,
	CustomFields: 
	[
		{
			"Id": 0,
			"Name": "String",
			"Description": "String",
			"Width": 0,
			"DataType": "String",
			"DefaultValue": "String",
			"IsMandatory": false,
			"MandatoryErrorMessage": "String",
			"MaxLength": 0,
			"MultipleLineText": false,
			"RegEx": "String",
			"RegExErrorMessage": "String",
			"Values": 
			[
				{
					"Value": "String"
				}
			]
		}
	],
	CustomFieldValues: 
	[
		{
			Id: 0,
			Column: String,
			Name: String,
			Description: String,
			Value: String,
			DataType: String
		}
	],
	Comments: 
	[
		{
			Id: 0,
			Comments: String
		}
	],
	AccessKeys: 
	[
		{
			AccessKeyTypeId: 0,
			Value: String,
			Description: String
		}
	],
	ResponseStatus: {},
	SubscribedToNewsletter: False,
	InvoiceAddress: 
	{
		UserId: 00000000-0000-0000-0000-000000000000,
		CorporateIdentityNumber: String,
		InvoiceAddress1: String,
		InvoiceAddress2: String,
		InvoiceCity: String,
		InvoicePostalCode: String,
		InvoiceCountryCode: String
	}
}