Booster.Microservices

<back to all web services

GetCustomerSuggestion

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/GetCustomerSuggestion
namespace Booster.Microservices.ServiceModel.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BaseResponse() = 
        member val _xmlns:String = null with get,set
        member val _type:String = null with get,set
        member val _source:String = null with get,set
        member val _tstamp:String = null with get,set
        member val _user:String = null with get,set
        member val _env:String = null with get,set
        member val _uri:String = null with get,set
        member val _query:String = null with get,set

    [<AllowNullLiteral>]
    type CustomerAddress() = 
        member val addressId:Guid = new Guid() with get,set
        member val description:String = null with get,set
        member val addressLine1:String = null with get,set
        member val addressLine2:String = null with get,set
        member val addressLine3:String = null with get,set
        member val addressLine4:String = null with get,set
        member val addressLine5:String = null with get,set
        member val houseNumber:String = null with get,set
        member val city:String = null with get,set
        member val region:String = null with get,set
        member val county:String = null with get,set
        member val stateOrProvinceId:String = null with get,set
        member val countryId:String = null with get,set
        member val countryDs:String = null with get,set
        member val zipCode:String = null with get,set
        member val addressTypeId:String = null with get,set
        member val isMailingAddress:Boolean = new Boolean() with get,set
        member val isMainAddress:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomerEmail() = 
        member val emailId:Guid = new Guid() with get,set
        member val description:String = null with get,set
        member val email:String = null with get,set
        member val isMainEmail:Boolean = new Boolean() with get,set
        member val type:Lookup<Char> = null with get,set

    [<AllowNullLiteral>]
    type CustomerPhone() = 
        member val phoneId:Guid = new Guid() with get,set
        member val description:String = null with get,set
        member val phone:String = null with get,set
        member val isMainPhone:Boolean = new Boolean() with get,set
        member val prefixCountryId:String = null with get,set
        member val telephonePrefix:String = null with get,set
        member val type:Lookup<Int32> = null with get,set

    [<AllowNullLiteral>]
    type GetCustomerSuggestionResponse() = 
        inherit BaseResponse()
        member val customerType:String = null with get,set
        member val customerRef:String = null with get,set
        member val title:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val titleDs:String = null with get,set
        member val firstName:String = null with get,set
        member val lastName:String = null with get,set
        member val firstNameNotLatin:String = null with get,set
        member val lastNameNotLatin:String = null with get,set
        member val birthday:String = null with get,set
        member val birthDayEventId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val weddingDate:String = null with get,set
        member val canBeContacted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val seller:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val language:String = null with get,set
        member val languageDs:String = null with get,set
        member val nameSuffix:String = null with get,set
        member val gender:String = null with get,set
        member val companyName:String = null with get,set
        member val middleName:String = null with get,set
        member val customerId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val personId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val boosterCustomerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val posOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val brandOwnerId:String = null with get,set
        member val businessUnitId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val sapGenderId:String = null with get,set
        member val allowStoreDataAbroad:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val privacyPolicyAcceptanceStorage:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val tvAllowStoreDataAbroad:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val tvPrivacyPolicyAcceptanceStorage:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val contactByMail:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val contactByEmail:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val contactByPhone:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val contactBySMS:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val contactBySocialMedia:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val addresses:ResizeArray<CustomerAddress> = new ResizeArray<CustomerAddress>() with get,set
        member val emails:ResizeArray<CustomerEmail> = new ResizeArray<CustomerEmail>() with get,set
        member val phones:ResizeArray<CustomerPhone> = new ResizeArray<CustomerPhone>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetCustomerSuggestion() = 
        inherit BaseRequest<GetCustomerSuggestionResponse>()
        member val emailAddress:String = null with get,set
        member val posId:Int32 = new Int32() with get,set
        member val brandTrigram:String = null with get,set
        member val phoneNumber:String = null with get,set
        member val prefixCountryId:String = null with get,set
        member val countryId:String = null with get,set

    [<AllowNullLiteral>]
    type BaseRequest<TResponse>() = 
        member val sid:String = null with get,set
        member val app:String = null with get,set
        member val _os:String = null with get,set
        member val _appVersion:String = null with get,set
        member val _searchMethod:String = null with get,set

    [<AllowNullLiteral>]
    type Lookup<T>() = 
        member val Id:T = null with get,set
        member val Description:String = null with get,set

F# GetCustomerSuggestion DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /warranty/v1/GetCustomerSuggestion HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	emailAddress: String,
	posId: 0,
	brandTrigram: String,
	phoneNumber: String,
	prefixCountryId: String,
	countryId: String,
	sid: String,
	app: String,
	_os: String,
	_appVersion: String,
	_searchMethod: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	customerType: String,
	customerRef: String,
	title: 0,
	titleDs: String,
	firstName: String,
	lastName: String,
	firstNameNotLatin: String,
	lastNameNotLatin: String,
	birthday: String,
	birthDayEventId: 00000000000000000000000000000000,
	weddingDate: String,
	canBeContacted: False,
	seller: 00000000000000000000000000000000,
	language: String,
	languageDs: String,
	nameSuffix: String,
	gender: String,
	companyName: String,
	middleName: String,
	customerId: 00000000000000000000000000000000,
	personId: 00000000000000000000000000000000,
	boosterCustomerId: 0,
	posOwnerId: 0,
	brandOwnerId: String,
	businessUnitId: 0,
	sapGenderId: String,
	allowStoreDataAbroad: False,
	privacyPolicyAcceptanceStorage: False,
	tvAllowStoreDataAbroad: False,
	tvPrivacyPolicyAcceptanceStorage: False,
	contactByMail: False,
	contactByEmail: False,
	contactByPhone: False,
	contactBySMS: False,
	contactBySocialMedia: False,
	addresses: 
	[
		{
			addressId: 00000000000000000000000000000000,
			description: String,
			addressLine1: String,
			addressLine2: String,
			addressLine3: String,
			addressLine4: String,
			addressLine5: String,
			houseNumber: String,
			city: String,
			region: String,
			county: String,
			stateOrProvinceId: String,
			countryId: String,
			countryDs: String,
			zipCode: String,
			addressTypeId: String,
			isMailingAddress: False,
			isMainAddress: False
		}
	],
	emails: 
	[
		{
			emailId: 00000000000000000000000000000000,
			description: String,
			email: String,
			isMainEmail: False,
			type: 
			{
				Id: ,
				Description: String
			}
		}
	],
	phones: 
	[
		{
			phoneId: 00000000000000000000000000000000,
			description: String,
			phone: String,
			isMainPhone: False,
			prefixCountryId: String,
			telephonePrefix: String,
			type: 
			{
				Id: 0,
				Description: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}