Booster.Microservices

ValidatePostalAddress

The following routes are available for this service:
POST	/warranty/v1/ValidatePostalAddress

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(Generic[TResponse], IRequest):
    sid: Optional[str] = None
    app: Optional[str] = None
    _os: Optional[str] = None
    _app_version: Optional[str] = None
    _search_method: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IRespose):
    _xmlns: Optional[str] = None
    _type: Optional[str] = None
    _source: Optional[str] = None
    _tstamp: Optional[str] = None
    _user: Optional[str] = None
    _env: Optional[str] = None
    _uri: Optional[str] = None
    _query: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class status:
    error_code: Optional[str] = None
    validation_status_code: Optional[str] = None
    status_id: int = 0
    error_description: Optional[str] = None
    status_description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class suggestion:
    zip_code: Optional[str] = None
    region_id: Optional[str] = None
    region_description: Optional[str] = None
    city: Optional[str] = None
    street: Optional[str] = None
    house_number: Optional[str] = None
    country_id: Optional[str] = None
    country_description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidatePostalAddressResponse(BaseResponse):
    response_status: Optional[ResponseStatus] = None
    status: Optional[status] = None
    suggestion: Optional[suggestion] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidatePostalAddress(BaseRequest[ValidatePostalAddressResponse]):
    zip_code: Optional[str] = None
    region: Optional[str] = None
    city: Optional[str] = None
    street: Optional[str] = None
    house_number: Optional[str] = None
    country_id: Optional[str] = None

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

{
	zipCode: String,
	region: String,
	city: String,
	street: String,
	houseNumber: 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
		}
	},
	status: 
	{
		errorCode: String,
		validationStatusCode: String,
		statusId: 0,
		errorDescription: String,
		statusDescription: String
	},
	suggestion: 
	{
		zipCode: String,
		regionId: String,
		regionDescription: String,
		city: String,
		street: String,
		houseNumber: String,
		countryId: String,
		countryDescription: String
	},
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}