Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress
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 status() = 
        member val errorCode:String = null with get,set
        member val validationStatusCode:String = null with get,set
        member val statusId:Int32 = new Int32() with get,set
        member val errorDescription:String = null with get,set
        member val statusDescription:String = null with get,set

    [<AllowNullLiteral>]
    type suggestion() = 
        member val zipCode:String = null with get,set
        member val regionId:String = null with get,set
        member val regionDescription:String = null with get,set
        member val city:String = null with get,set
        member val street:String = null with get,set
        member val houseNumber:String = null with get,set
        member val countryId:String = null with get,set
        member val countryDescription:String = null with get,set

    [<AllowNullLiteral>]
    type ValidatePostalAddressResponse() = 
        inherit BaseResponse()
        member val ResponseStatus:ResponseStatus = null with get,set
        member val status:status = null with get,set
        member val suggestion:suggestion = null with get,set

    [<AllowNullLiteral>]
    type ValidatePostalAddress() = 
        inherit BaseRequest<ValidatePostalAddressResponse>()
        member val zipCode:String = null with get,set
        member val region:String = null with get,set
        member val city:String = null with get,set
        member val street:String = null with get,set
        member val houseNumber: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

F# 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
}