Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ValidatePostalAddress : BaseRequest<ValidatePostalAddressResponse>()
{
    var zipCode:String? = null
    var region:String? = null
    var city:String? = null
    var street:String? = null
    var houseNumber:String? = null
    var countryId:String? = null
}

open class BaseRequest<TResponse> : IRequest
{
    var sid:String? = null
    var app:String? = null
    var _os:String? = null
    var _appVersion:String? = null
    var _searchMethod:String? = null
}

open class ValidatePostalAddressResponse : BaseResponse()
{
    var ResponseStatus:ResponseStatus? = null
    var status:status? = null
    var suggestion:suggestion? = null
}

open class BaseResponse : IRespose
{
    var _xmlns:String? = null
    var _type:String? = null
    var _source:String? = null
    var _tstamp:String? = null
    var _user:String? = null
    var _env:String? = null
    var _uri:String? = null
    var _query:String? = null
}

open class status
{
    var errorCode:String? = null
    var validationStatusCode:String? = null
    var statusId:Int? = null
    var errorDescription:String? = null
    var statusDescription:String? = null
}

open class suggestion
{
    var zipCode:String? = null
    var regionId:String? = null
    var regionDescription:String? = null
    var city:String? = null
    var street:String? = null
    var houseNumber:String? = null
    var countryId:String? = null
    var countryDescription:String? = null
}

Kotlin 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
}