Richemont.Booster2.PublicApi

<back to all web services

GetCustomer

Requires Authentication
The following routes are available for this service:
GET/customer/{boosterCustomerId}Get customer detailsGet Customer info based on the Booster Customer ID

export class CustomerEmail
{
    /** @description Description */
    // @ApiMember(Description="Description", IsRequired=true)
    public description: string;

    /** @description Email Address */
    // @ApiMember(Description="Email Address", IsRequired=true)
    public email: string;

    /** @description Is main email address */
    // @ApiMember(Description="Is main email address", IsRequired=true)
    public isMain: boolean;

    public constructor(init?: Partial<CustomerEmail>) { (Object as any).assign(this, init); }
}

export class CustomerPhone
{
    /** @description Description */
    // @ApiMember(Description="Description", IsRequired=true)
    public description: string;

    /** @description Phone Number */
    // @ApiMember(Description="Phone Number", IsRequired=true)
    public phone: string;

    /** @description Is main phone number  */
    // @ApiMember(Description="Is main phone number ", IsRequired=true)
    public isMain: boolean;

    /** @description Phone number country prefix */
    // @ApiMember(Description="Phone number country prefix", IsRequired=true)
    public prefixCountryId: string;

    /** @description Telephone prefix */
    // @ApiMember(Description="Telephone prefix", IsRequired=true)
    public telephonePrefix: string;

    public constructor(init?: Partial<CustomerPhone>) { (Object as any).assign(this, init); }
}

export class CustomerEvent
{
    /** @description Event Id */
    // @ApiMember(Description="Event Id", IsRequired=true)
    public eventId: number;

    /** @description Event Description  */
    // @ApiMember(Description="Event Description ", IsRequired=true)
    public eventDescription: string;

    /** @description Event Other */
    // @ApiMember(Description="Event Other", IsRequired=true)
    public eventTypeOther: string;

    /** @description Comment */
    // @ApiMember(Description="Comment", IsRequired=true)
    public comment: string;

    /** @description Event Day */
    // @ApiMember(Description="Event Day", IsRequired=true)
    public eventDay: number;

    /** @description Event Month */
    // @ApiMember(Description="Event Month", IsRequired=true)
    public eventMonth: number;

    /** @description Event Year */
    // @ApiMember(Description="Event Year", IsRequired=true)
    public eventYear: number;

    public constructor(init?: Partial<CustomerEvent>) { (Object as any).assign(this, init); }
}

export class GetCustomerResponse
{
    /** @description Booster Customer ID */
    // @ApiMember(Description="Booster Customer ID", IsRequired=true)
    public id: number;

    /** @description SAP Customer ID */
    // @ApiMember(Description="SAP Customer ID", IsRequired=true)
    public sapId: string;

    /** @description Customer Reference */
    // @ApiMember(Description="Customer Reference", IsRequired=true)
    public customerReference: string;

    /** @description Gender */
    // @ApiMember(Description="Gender", IsRequired=true)
    public gender: string;

    /** @description Personal Title */
    // @ApiMember(Description="Personal Title", IsRequired=true)
    public personalTitle: string;

    /** @description First Name */
    // @ApiMember(Description="First Name", IsRequired=true)
    public firstName: string;

    /** @description Customer Last Name */
    // @ApiMember(Description="Customer Last Name", IsRequired=true)
    public lastName: string;

    /** @description First Name Not Latin */
    // @ApiMember(Description="First Name Not Latin", IsRequired=true)
    public firstNameNotLatin: string;

    /** @description Customer Last Name Not Latin */
    // @ApiMember(Description="Customer Last Name Not Latin", IsRequired=true)
    public lastNameNotLatin: string;

    /** @description Middle Name */
    // @ApiMember(Description="Middle Name", IsRequired=true)
    public middleName: string;

    /** @description Can be contacted or not? */
    // @ApiMember(Description="Can be contacted or not?", IsRequired=true)
    public canBeContacted: boolean;

    /** @description Language */
    // @ApiMember(Description="Language", IsRequired=true)
    public language: string;

    /** @description Country */
    // @ApiMember(Description="Country", IsRequired=true)
    public countryId: string;

    /** @description Brand Trigram */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public brand: string;

    /** @description List of Emails */
    // @ApiMember(Description="List of Emails", IsRequired=true)
    public emails: CustomerEmail[];

    /** @description List of Phone Numbers */
    // @ApiMember(Description="List of Phone Numbers", IsRequired=true)
    public phones: CustomerPhone[];

    /** @description List of Events */
    // @ApiMember(Description="List of Events", IsRequired=true)
    public events: CustomerEvent[];

    /** @description Registration date */
    // @ApiMember(Description="Registration date")
    public registrationDate?: string;

    public constructor(init?: Partial<GetCustomerResponse>) { (Object as any).assign(this, init); }
}

export class GetCustomer
{
    /** @description Booster Customer ID */
    // @ApiMember(Description="Booster Customer ID", IsRequired=true)
    public boosterCustomerId: number;

    public constructor(init?: Partial<GetCustomer>) { (Object as any).assign(this, init); }
}

TypeScript GetCustomer DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel">
  <brand>String</brand>
  <canBeContacted>false</canBeContacted>
  <countryId>String</countryId>
  <customerReference>String</customerReference>
  <emails>
    <CustomerEmail>
      <description>String</description>
      <email>String</email>
      <isMain>false</isMain>
    </CustomerEmail>
  </emails>
  <events>
    <CustomerEvent>
      <comment>String</comment>
      <eventDay>0</eventDay>
      <eventDescription>String</eventDescription>
      <eventId>0</eventId>
      <eventMonth>0</eventMonth>
      <eventTypeOther>String</eventTypeOther>
      <eventYear>0</eventYear>
    </CustomerEvent>
  </events>
  <firstName>String</firstName>
  <firstNameNotLatin>String</firstNameNotLatin>
  <gender>String</gender>
  <id>0</id>
  <language>String</language>
  <lastName>String</lastName>
  <lastNameNotLatin>String</lastNameNotLatin>
  <middleName>String</middleName>
  <personalTitle>String</personalTitle>
  <phones>
    <CustomerPhone>
      <description>String</description>
      <isMain>false</isMain>
      <phone>String</phone>
      <prefixCountryId>String</prefixCountryId>
      <telephonePrefix>String</telephonePrefix>
    </CustomerPhone>
  </phones>
  <registrationDate>0001-01-01T00:00:00</registrationDate>
  <sapId>String</sapId>
</GetCustomerResponse>