| GET | /customer/{boosterCustomerId} | Get customer details | Get Customer info based on the Booster Customer ID |
|---|
import Foundation
import ServiceStack
public class GetCustomer : Codable
{
/**
* Booster Customer ID
*/
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public var boosterCustomerId:Int
required public init(){}
}
public class GetCustomerResponse : Codable
{
/**
* Booster Customer ID
*/
// @ApiMember(Description="Booster Customer ID", IsRequired=true)
public var id:Int
/**
* SAP Customer ID
*/
// @ApiMember(Description="SAP Customer ID", IsRequired=true)
public var sapId:String
/**
* Customer Reference
*/
// @ApiMember(Description="Customer Reference", IsRequired=true)
public var customerReference:String
/**
* Gender
*/
// @ApiMember(Description="Gender", IsRequired=true)
public var gender:String
/**
* Personal Title
*/
// @ApiMember(Description="Personal Title", IsRequired=true)
public var personalTitle:String
/**
* First Name
*/
// @ApiMember(Description="First Name", IsRequired=true)
public var firstName:String
/**
* Customer Last Name
*/
// @ApiMember(Description="Customer Last Name", IsRequired=true)
public var lastName:String
/**
* First Name Not Latin
*/
// @ApiMember(Description="First Name Not Latin", IsRequired=true)
public var firstNameNotLatin:String
/**
* Customer Last Name Not Latin
*/
// @ApiMember(Description="Customer Last Name Not Latin", IsRequired=true)
public var lastNameNotLatin:String
/**
* Middle Name
*/
// @ApiMember(Description="Middle Name", IsRequired=true)
public var middleName:String
/**
* Can be contacted or not?
*/
// @ApiMember(Description="Can be contacted or not?", IsRequired=true)
public var canBeContacted:Bool
/**
* Language
*/
// @ApiMember(Description="Language", IsRequired=true)
public var language:String
/**
* Country
*/
// @ApiMember(Description="Country", IsRequired=true)
public var countryId:String
/**
* Brand Trigram
*/
// @ApiMember(Description="Brand Trigram", IsRequired=true)
public var brand:String
/**
* List of Emails
*/
// @ApiMember(Description="List of Emails", IsRequired=true)
public var emails:[CustomerEmail] = []
/**
* List of Phone Numbers
*/
// @ApiMember(Description="List of Phone Numbers", IsRequired=true)
public var phones:[CustomerPhone] = []
/**
* List of Events
*/
// @ApiMember(Description="List of Events", IsRequired=true)
public var events:[CustomerEvent] = []
/**
* Registration date
*/
// @ApiMember(Description="Registration date")
public var registrationDate:Date?
required public init(){}
}
public class CustomerEmail : Codable
{
/**
* Description
*/
// @ApiMember(Description="Description", IsRequired=true)
public var Description:String
/**
* Email Address
*/
// @ApiMember(Description="Email Address", IsRequired=true)
public var email:String
/**
* Is main email address
*/
// @ApiMember(Description="Is main email address", IsRequired=true)
public var isMain:Bool
required public init(){}
}
public class CustomerPhone : Codable
{
/**
* Description
*/
// @ApiMember(Description="Description", IsRequired=true)
public var Description:String
/**
* Phone Number
*/
// @ApiMember(Description="Phone Number", IsRequired=true)
public var phone:String
/**
* Is main phone number
*/
// @ApiMember(Description="Is main phone number ", IsRequired=true)
public var isMain:Bool
/**
* Phone number country prefix
*/
// @ApiMember(Description="Phone number country prefix", IsRequired=true)
public var prefixCountryId:String
/**
* Telephone prefix
*/
// @ApiMember(Description="Telephone prefix", IsRequired=true)
public var telephonePrefix:String
required public init(){}
}
public class CustomerEvent : Codable
{
/**
* Event Id
*/
// @ApiMember(Description="Event Id", IsRequired=true)
public var eventId:Int
/**
* Event Description
*/
// @ApiMember(Description="Event Description ", IsRequired=true)
public var eventDescription:String
/**
* Event Other
*/
// @ApiMember(Description="Event Other", IsRequired=true)
public var eventTypeOther:String
/**
* Comment
*/
// @ApiMember(Description="Comment", IsRequired=true)
public var comment:String
/**
* Event Day
*/
// @ApiMember(Description="Event Day", IsRequired=true)
public var eventDay:Int?
/**
* Event Month
*/
// @ApiMember(Description="Event Month", IsRequired=true)
public var eventMonth:Int?
/**
* Event Year
*/
// @ApiMember(Description="Event Year", IsRequired=true)
public var eventYear:Int?
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.
GET /customer/{boosterCustomerId} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 0,
sapId: String,
customerReference: String,
gender: String,
personalTitle: String,
firstName: String,
lastName: String,
firstNameNotLatin: String,
lastNameNotLatin: String,
middleName: String,
canBeContacted: False,
language: String,
countryId: String,
brand: String,
emails:
[
{
description: String,
email: String,
isMain: False
}
],
phones:
[
{
description: String,
phone: String,
isMain: False,
prefixCountryId: String,
telephonePrefix: String
}
],
events:
[
{
eventId: 0,
eventDescription: String,
eventTypeOther: String,
comment: String,
eventDay: 0,
eventMonth: 0,
eventYear: 0
}
],
registrationDate: 0001-01-01
}