Booster.Microservices

<back to all web services

ValidatePhoneNumber

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePhoneNumber

export class BaseRequest<TResponse> implements IRequest
{
    public sid: string;
    public app: string;
    public _os: string;
    public _appVersion: string;
    public _searchMethod: string;

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

export class BaseResponse implements IRespose
{
    public _xmlns: string;
    public _type: string;
    public _source: string;
    public _tstamp: string;
    public _user: string;
    public _env: string;
    public _uri: string;
    public _query: string;

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

export class ValidatePhoneNumberResponse extends BaseResponse
{
    public ResponseStatus: ResponseStatus;
    public isValid?: boolean;
    public countryId: string;
    public nationalNumber: string;
    public nationalFormat: string;

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

export class ValidatePhoneNumber extends BaseRequest<ValidatePhoneNumberResponse>
{
    public phoneNumber: string;
    public countryId: string;

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

TypeScript ValidatePhoneNumber 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/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
}