| 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. |
|---|
import Foundation
import ServiceStack
// @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")
public class CreateCustomer : Codable
{
/**
* 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 var companyId:String?
// @ApiMember(IsRequired=true)
public var firstname:String
// @ApiMember(IsRequired=true)
public var lastname:String
// @ApiMember(IsRequired=true)
public var phone:String
// @ApiMember()
public var email:String
/**
* 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 var customFields:[AddCustomField] = []
/**
* List of Access Keys
*/
// @ApiMember(Description="List of Access Keys")
public var accessKeys:[AddUserAccessKey] = []
/**
* Customer invoice adress
*/
// @ApiMember(Description="Customer invoice adress")
public var invoiceAddress:InvoiceAddress
required public init(){}
}
public class AddCustomField : Codable
{
public var id:Int
public var value:String
required public init(){}
}
public class AddUserAccessKey : Codable
{
public var id:String?
public var companyId:String?
public var accessKeyTypeId:Int
public var value:String
public var customerId:String?
public var Description:String
required public init(){}
}
public class InvoiceAddress : Codable
{
public var corporateIdentityNumber:String
public var invoiceAddress1:String
public var invoiceAddress2:String
public var invoiceCity:String
public var invoicePostalCode:String
public var invoiceCountryCode:String
required public init(){}
}
public class UpdateCustomerResponse : CustomerQueryResponse
{
public var facebookUserName:String
public var userId:String?
public var companyId:String?
public var createdDate:Date?
public var deletedAccessKeys:[UserAccessKeys] = []
public var createdOrUpdatedAccessKeys:[UserAccessKeys] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case facebookUserName
case userId
case companyId
case createdDate
case deletedAccessKeys
case createdOrUpdatedAccessKeys
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
facebookUserName = try container.decodeIfPresent(String.self, forKey: .facebookUserName)
userId = try container.decodeIfPresent(String.self, forKey: .userId)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
deletedAccessKeys = try container.decodeIfPresent([UserAccessKeys].self, forKey: .deletedAccessKeys) ?? []
createdOrUpdatedAccessKeys = try container.decodeIfPresent([UserAccessKeys].self, forKey: .createdOrUpdatedAccessKeys) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if facebookUserName != nil { try container.encode(facebookUserName, forKey: .facebookUserName) }
if userId != nil { try container.encode(userId, forKey: .userId) }
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if createdDate != nil { try container.encode(createdDate, forKey: .createdDate) }
if deletedAccessKeys.count > 0 { try container.encode(deletedAccessKeys, forKey: .deletedAccessKeys) }
if createdOrUpdatedAccessKeys.count > 0 { try container.encode(createdOrUpdatedAccessKeys, forKey: .createdOrUpdatedAccessKeys) }
}
}
public class CustomerQueryResponse : Codable
{
public var id:String
public var firstname:String
public var lastname:String
public var email:String
public var phone:String
public var imageUrl:String
public var customFields:[CustomFieldConfigData] = []
public var customFieldValues:[CustomFieldDataResponse] = []
public var comments:[CustomerCommentsResponse] = []
public var accessKeys:[UserAccessKeys] = []
public var updated:Date
public var created:Date
//responseStatus:Object ignored. Type could not be extended in Swift
public var subscribedToNewsletter:Bool
public var invoiceAddress:InvoiceAddress
required public init(){}
}
public class CustomFieldConfigData : Codable
{
/**
* Custom field id
*/
// @ApiMember(Description="Custom field id")
public var id:Int
/**
* Configuration name. Example: 'Number of persons'.
*/
// @ApiMember(Description="Configuration name. Example: 'Number of persons'.")
public var name:String
/**
* 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 var Description:String
/**
* Field width. Example: 20 for 20px
*/
// @ApiMember(Description="Field width. Example: 20 for 20px")
public var width:Int?
/**
* 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 var dataType:String
/**
* Default value of the field. Example: '3'
*/
// @ApiMember(Description="Default value of the field. Example: '3'")
public var defaultValue:String
/**
* 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 var isMandatory:Bool
/**
* 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 var mandatoryErrorMessage:String
/**
* Max lenght of the field
*/
// @ApiMember(Description="Max lenght of the field")
public var maxLength:Int
/**
* If the field should have multiple lines
*/
// @ApiMember(Description="If the field should have multiple lines")
public var multipleLineText:Bool
/**
* Regular expression used for validation of the field
*/
// @ApiMember(Description="Regular expression used for validation of the field")
public var regEx:String
/**
* Error message shown if the regular expression validation failed
*/
// @ApiMember(Description="Error message shown if the regular expression validation failed")
public var regExErrorMessage:String
/**
* 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 var values:[CustomFieldValueResponse] = []
required public init(){}
}
public class CustomFieldValueResponse : Codable
{
public var value:String
required public init(){}
}
public class CustomFieldDataResponse : Codable
{
public var id:Int
public var column:String
public var name:String
public var Description:String
public var value:String
/**
* 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 var dataType:String
required public init(){}
}
public class CustomerCommentsResponse : Codable
{
public var id:Int
public var customerId:String
public var comments:String
public var updated:Date
public var created:Date
public var imageUrl:Uri
required public init(){}
}
public class UserAccessKeys : BaseModel
{
// @Required()
public var companyId:String?
// @Required()
public var accessKeyTypeId:Int?
// @Required()
public var value:String?
// @Required()
public var customerId:String?
public var Description:String
// @Required()
public var id:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case accessKeyTypeId
case value
case customerId
case Description
case id
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
accessKeyTypeId = try container.decodeIfPresent(Int.self, forKey: .accessKeyTypeId)
value = try container.decodeIfPresent(String.self, forKey: .value)
customerId = try container.decodeIfPresent(String.self, forKey: .customerId)
Description = try container.decodeIfPresent(String.self, forKey: .Description)
id = try container.decodeIfPresent(String.self, forKey: .id)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if accessKeyTypeId != nil { try container.encode(accessKeyTypeId, forKey: .accessKeyTypeId) }
if value != nil { try container.encode(value, forKey: .value) }
if customerId != nil { try container.encode(customerId, forKey: .customerId) }
if Description != nil { try container.encode(Description, forKey: .Description) }
if id != nil { try container.encode(id, forKey: .id) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
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 /customers HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
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/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:
{
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
}
}