| Required role: | bookingsupplier-administrator-write |
| 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. |
|---|
export class CustomFieldValueResponse
{
public Value: string;
public constructor(init?: Partial<CustomFieldValueResponse>) { (Object as any).assign(this, init); }
}
export class CustomFieldConfigData
{
/** @description Custom field id */
// @ApiMember(Description="Custom field id")
public Id: number;
/** @description Configuration name. Example: 'Number of persons'. */
// @ApiMember(Description="Configuration name. Example: 'Number of persons'.")
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?'")
public Description: string;
/** @description Field width. Example: 20 for 20px */
// @ApiMember(Description="Field width. Example: 20 for 20px")
public Width?: number;
/** @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 Error message shown if the regular expression validation failed */
// @ApiMember(Description="Error message shown if the regular expression validation failed")
public RegExErrorMessage: 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: CustomFieldValueResponse[];
public constructor(init?: Partial<CustomFieldConfigData>) { (Object as any).assign(this, init); }
}
export class CustomFieldDataResponse
{
public Id: number;
public Column: string;
public Name: string;
public Description: string;
public Value: 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;
public constructor(init?: Partial<CustomFieldDataResponse>) { (Object as any).assign(this, init); }
}
export class CustomerCommentsResponse
{
public Id: number;
public CustomerId: string;
public Comments: string;
public Updated: string;
public Created: string;
public ImageUrl: string;
public constructor(init?: Partial<CustomerCommentsResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class UserAccessKeys extends BaseModel
{
// @Required()
public CompanyId: string;
// @Required()
public AccessKeyTypeId: number;
// @Required()
public Value: string;
// @Required()
public CustomerId: string;
public Description: string;
// @Required()
public Id: string;
public constructor(init?: Partial<UserAccessKeys>) { super(init); (Object as any).assign(this, init); }
}
export class InvoiceAddress
{
public CorporateIdentityNumber: string;
public InvoiceAddress1: string;
public InvoiceAddress2: string;
public InvoiceCity: string;
public InvoicePostalCode: string;
public InvoiceCountryCode: string;
public constructor(init?: Partial<InvoiceAddress>) { (Object as any).assign(this, init); }
}
export class CustomerQueryResponse
{
public Id: string;
public Firstname: string;
public Lastname: string;
public Email: string;
public Phone: string;
public ImageUrl: string;
public CustomFields: CustomFieldConfigData[];
public CustomFieldValues: CustomFieldDataResponse[];
public Comments: CustomerCommentsResponse[];
public AccessKeys: UserAccessKeys[];
public Updated: string;
public Created: string;
public ResponseStatus: Object;
public SubscribedToNewsletter: boolean;
public InvoiceAddress: InvoiceAddress;
public constructor(init?: Partial<CustomerQueryResponse>) { (Object as any).assign(this, init); }
}
export class UpdateCustomerResponse extends CustomerQueryResponse
{
public FacebookUserName: string;
public UserId?: string;
public CompanyId?: string;
public CreatedDate?: string;
public DeletedAccessKeys: UserAccessKeys[];
public CreatedOrUpdatedAccessKeys: UserAccessKeys[];
public constructor(init?: Partial<UpdateCustomerResponse>) { super(init); (Object as any).assign(this, init); }
}
export class AddCustomField
{
public Id: number;
public Value: string;
public constructor(init?: Partial<AddCustomField>) { (Object as any).assign(this, init); }
}
export class AddUserAccessKey
{
public Id?: string;
public CompanyId?: string;
public AccessKeyTypeId: number;
public Value: string;
public CustomerId?: string;
public Description: string;
public constructor(init?: Partial<AddUserAccessKey>) { (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 CreateCustomer
{
/** @description Enter the company and id for the customer, if blank company id and you are an admin, your company id will be used. */
// @ApiMember(Description="Enter the company and id for the customer, if blank company id and you are an admin, your company id will be used.", ParameterType="query")
public CompanyId?: string;
// @ApiMember(IsRequired=true)
public Firstname: string;
// @ApiMember(IsRequired=true)
public Lastname: string;
// @ApiMember(IsRequired=true)
public Phone: string;
// @ApiMember()
public Email: string;
/** @description If Custom Fields are added to the customer, here you will send the id and the value for each custom field to be updated */
// @ApiMember(Description="If Custom Fields are added to the customer, here you will send the id and the value for each custom field to be updated")
public CustomFields: AddCustomField[];
/** @description List of Access Keys */
// @ApiMember(Description="List of Access Keys")
public AccessKeys: AddUserAccessKey[];
/** @description Customer invoice adress */
// @ApiMember(Description="Customer invoice adress")
public InvoiceAddress: InvoiceAddress;
public constructor(init?: Partial<CreateCustomer>) { (Object as any).assign(this, init); }
}
TypeScript CreateCustomer DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Firstname":"String","Lastname":"String","Phone":"String","Email":"String","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"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"}}