Richemont.Booster2.PublicApi

<back to all web services

GetCustomer

"use strict";
export class CustomerEmail {
    /** @param {{description?:string,email?:string,isMain?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Description */
    description;
    /**
     * @type {string}
     * @description Email Address */
    email;
    /**
     * @type {boolean}
     * @description Is main email address */
    isMain;
}
export class CustomerPhone {
    /** @param {{description?:string,phone?:string,isMain?:boolean,prefixCountryId?:string,telephonePrefix?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Description */
    description;
    /**
     * @type {string}
     * @description Phone Number */
    phone;
    /**
     * @type {boolean}
     * @description Is main phone number  */
    isMain;
    /**
     * @type {string}
     * @description Phone number country prefix */
    prefixCountryId;
    /**
     * @type {string}
     * @description Telephone prefix */
    telephonePrefix;
}
export class CustomerEvent {
    /** @param {{eventId?:number,eventDescription?:string,eventTypeOther?:string,comment?:string,eventDay?:number,eventMonth?:number,eventYear?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Event Id */
    eventId;
    /**
     * @type {string}
     * @description Event Description  */
    eventDescription;
    /**
     * @type {string}
     * @description Event Other */
    eventTypeOther;
    /**
     * @type {string}
     * @description Comment */
    comment;
    /**
     * @type {number}
     * @description Event Day */
    eventDay;
    /**
     * @type {number}
     * @description Event Month */
    eventMonth;
    /**
     * @type {number}
     * @description Event Year */
    eventYear;
}
export class GetCustomerResponse {
    /** @param {{id?:number,sapId?:string,customerReference?:string,gender?:string,personalTitle?:string,firstName?:string,lastName?:string,firstNameNotLatin?:string,lastNameNotLatin?:string,middleName?:string,canBeContacted?:boolean,language?:string,countryId?:string,brand?:string,emails?:CustomerEmail[],phones?:CustomerPhone[],events?:CustomerEvent[],registrationDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    id;
    /**
     * @type {string}
     * @description SAP Customer ID */
    sapId;
    /**
     * @type {string}
     * @description Customer Reference */
    customerReference;
    /**
     * @type {string}
     * @description Gender */
    gender;
    /**
     * @type {string}
     * @description Personal Title */
    personalTitle;
    /**
     * @type {string}
     * @description First Name */
    firstName;
    /**
     * @type {string}
     * @description Customer Last Name */
    lastName;
    /**
     * @type {string}
     * @description First Name Not Latin */
    firstNameNotLatin;
    /**
     * @type {string}
     * @description Customer Last Name Not Latin */
    lastNameNotLatin;
    /**
     * @type {string}
     * @description Middle Name */
    middleName;
    /**
     * @type {boolean}
     * @description Can be contacted or not? */
    canBeContacted;
    /**
     * @type {string}
     * @description Language */
    language;
    /**
     * @type {string}
     * @description Country */
    countryId;
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {CustomerEmail[]}
     * @description List of Emails */
    emails;
    /**
     * @type {CustomerPhone[]}
     * @description List of Phone Numbers */
    phones;
    /**
     * @type {CustomerEvent[]}
     * @description List of Events */
    events;
    /**
     * @type {?string}
     * @description Registration date */
    registrationDate;
}
export class GetCustomer {
    /** @param {{boosterCustomerId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    boosterCustomerId;
}

JavaScript GetCustomer DTOs

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>