| GET | /customer/{boosterCustomerId} | Get customer details | Get Customer info based on the Booster Customer ID |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.CRM.ServiceModel
Namespace Global
Namespace Richemont.Booster2.PublicApi.CRM.ServiceModel
Public Partial Class CustomerEmail
'''<Summary>
'''Description
'''</Summary>
<ApiMember(Description:="Description", IsRequired:=true)>
Public Overridable Property description As String
'''<Summary>
'''Email Address
'''</Summary>
<ApiMember(Description:="Email Address", IsRequired:=true)>
Public Overridable Property email As String
'''<Summary>
'''Is main email address
'''</Summary>
<ApiMember(Description:="Is main email address", IsRequired:=true)>
Public Overridable Property isMain As Boolean
End Class
Public Partial Class CustomerEvent
'''<Summary>
'''Event Id
'''</Summary>
<ApiMember(Description:="Event Id", IsRequired:=true)>
Public Overridable Property eventId As Integer
'''<Summary>
'''Event Description
'''</Summary>
<ApiMember(Description:="Event Description ", IsRequired:=true)>
Public Overridable Property eventDescription As String
'''<Summary>
'''Event Other
'''</Summary>
<ApiMember(Description:="Event Other", IsRequired:=true)>
Public Overridable Property eventTypeOther As String
'''<Summary>
'''Comment
'''</Summary>
<ApiMember(Description:="Comment", IsRequired:=true)>
Public Overridable Property comment As String
'''<Summary>
'''Event Day
'''</Summary>
<ApiMember(Description:="Event Day", IsRequired:=true)>
Public Overridable Property eventDay As Nullable(Of Integer)
'''<Summary>
'''Event Month
'''</Summary>
<ApiMember(Description:="Event Month", IsRequired:=true)>
Public Overridable Property eventMonth As Nullable(Of Integer)
'''<Summary>
'''Event Year
'''</Summary>
<ApiMember(Description:="Event Year", IsRequired:=true)>
Public Overridable Property eventYear As Nullable(Of Integer)
End Class
Public Partial Class CustomerPhone
'''<Summary>
'''Description
'''</Summary>
<ApiMember(Description:="Description", IsRequired:=true)>
Public Overridable Property description As String
'''<Summary>
'''Phone Number
'''</Summary>
<ApiMember(Description:="Phone Number", IsRequired:=true)>
Public Overridable Property phone As String
'''<Summary>
'''Is main phone number
'''</Summary>
<ApiMember(Description:="Is main phone number ", IsRequired:=true)>
Public Overridable Property isMain As Boolean
'''<Summary>
'''Phone number country prefix
'''</Summary>
<ApiMember(Description:="Phone number country prefix", IsRequired:=true)>
Public Overridable Property prefixCountryId As String
'''<Summary>
'''Telephone prefix
'''</Summary>
<ApiMember(Description:="Telephone prefix", IsRequired:=true)>
Public Overridable Property telephonePrefix As String
End Class
Public Partial Class GetCustomer
'''<Summary>
'''Booster Customer ID
'''</Summary>
<ApiMember(Description:="Booster Customer ID", IsRequired:=true)>
Public Overridable Property boosterCustomerId As Integer
End Class
Public Partial Class GetCustomerResponse
Public Sub New()
emails = New List(Of CustomerEmail)
phones = New List(Of CustomerPhone)
events = New List(Of CustomerEvent)
End Sub
'''<Summary>
'''Booster Customer ID
'''</Summary>
<ApiMember(Description:="Booster Customer ID", IsRequired:=true)>
Public Overridable Property id As Integer
'''<Summary>
'''SAP Customer ID
'''</Summary>
<ApiMember(Description:="SAP Customer ID", IsRequired:=true)>
Public Overridable Property sapId As String
'''<Summary>
'''Customer Reference
'''</Summary>
<ApiMember(Description:="Customer Reference", IsRequired:=true)>
Public Overridable Property customerReference As String
'''<Summary>
'''Gender
'''</Summary>
<ApiMember(Description:="Gender", IsRequired:=true)>
Public Overridable Property gender As String
'''<Summary>
'''Personal Title
'''</Summary>
<ApiMember(Description:="Personal Title", IsRequired:=true)>
Public Overridable Property personalTitle As String
'''<Summary>
'''First Name
'''</Summary>
<ApiMember(Description:="First Name", IsRequired:=true)>
Public Overridable Property firstName As String
'''<Summary>
'''Customer Last Name
'''</Summary>
<ApiMember(Description:="Customer Last Name", IsRequired:=true)>
Public Overridable Property lastName As String
'''<Summary>
'''First Name Not Latin
'''</Summary>
<ApiMember(Description:="First Name Not Latin", IsRequired:=true)>
Public Overridable Property firstNameNotLatin As String
'''<Summary>
'''Customer Last Name Not Latin
'''</Summary>
<ApiMember(Description:="Customer Last Name Not Latin", IsRequired:=true)>
Public Overridable Property lastNameNotLatin As String
'''<Summary>
'''Middle Name
'''</Summary>
<ApiMember(Description:="Middle Name", IsRequired:=true)>
Public Overridable Property middleName As String
'''<Summary>
'''Can be contacted or not?
'''</Summary>
<ApiMember(Description:="Can be contacted or not?", IsRequired:=true)>
Public Overridable Property canBeContacted As Boolean
'''<Summary>
'''Language
'''</Summary>
<ApiMember(Description:="Language", IsRequired:=true)>
Public Overridable Property language As String
'''<Summary>
'''Country
'''</Summary>
<ApiMember(Description:="Country", IsRequired:=true)>
Public Overridable Property countryId As String
'''<Summary>
'''Brand Trigram
'''</Summary>
<ApiMember(Description:="Brand Trigram", IsRequired:=true)>
Public Overridable Property brand As String
'''<Summary>
'''List of Emails
'''</Summary>
<ApiMember(Description:="List of Emails", IsRequired:=true)>
Public Overridable Property emails As List(Of CustomerEmail)
'''<Summary>
'''List of Phone Numbers
'''</Summary>
<ApiMember(Description:="List of Phone Numbers", IsRequired:=true)>
Public Overridable Property phones As List(Of CustomerPhone)
'''<Summary>
'''List of Events
'''</Summary>
<ApiMember(Description:="List of Events", IsRequired:=true)>
Public Overridable Property events As List(Of CustomerEvent)
'''<Summary>
'''Registration date
'''</Summary>
<ApiMember(Description:="Registration date")>
Public Overridable Property registrationDate As Nullable(Of Date)
End Class
End Namespace
End Namespace
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
}