Booster.Microservices

<back to all web services

ValidatePhoneNumber

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePhoneNumber
ValidatePhoneNumber Parameters:
NameParameterData TypeRequiredDescription
phoneNumberbodystringNo
countryIdbodystringNo
BaseRequest<TResponse> Parameters:
NameParameterData TypeRequiredDescription
sidformstringNo
appformstringNo
_osformstringNo
_appVersionformstringNo
_searchMethodformstringNo
ValidatePhoneNumberResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
isValidformbool?No
countryIdformstringNo
nationalNumberformstringNo
nationalFormatformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
_xmlnsformstringNo
_typeformstringNo
_sourceformstringNo
_tstampformstringNo
_userformstringNo
_envformstringNo
_uriformstringNo
_queryformstringNo
ValidatePhoneNumberResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
isValidformbool?No
countryIdformstringNo
nationalNumberformstringNo
nationalFormatformstringNo

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/ValidatePhoneNumber HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	phoneNumber: 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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	isValid: False,
	countryId: String,
	nationalNumber: String,
	nationalFormat: String,
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}