Booster.Microservices

<back to all web services

ValidatePostalAddress

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/ValidatePostalAddress
import 'package:servicestack/servicestack.dart';

class BaseRequest<TResponse> implements IRequest, IConvertible
{
    String? sid;
    String? app;
    String? _os;
    String? _appVersion;
    String? _searchMethod;

    BaseRequest({this.sid,this.app,this._os,this._appVersion,this._searchMethod});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        sid = json['sid'];
        app = json['app'];
        _os = json['_os'];
        _appVersion = json['_appVersion'];
        _searchMethod = json['_searchMethod'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'sid': sid,
        'app': app,
        '_os': _os,
        '_appVersion': _appVersion,
        '_searchMethod': _searchMethod
    };

    getTypeName() => "BaseRequest<$TResponse>";
    TypeContext? context = _ctx;
}

class BaseResponse implements IRespose, IConvertible
{
    String? _xmlns;
    String? _type;
    String? _source;
    String? _tstamp;
    String? _user;
    String? _env;
    String? _uri;
    String? _query;

    BaseResponse({this._xmlns,this._type,this._source,this._tstamp,this._user,this._env,this._uri,this._query});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        _xmlns = json['_xmlns'];
        _type = json['_type'];
        _source = json['_source'];
        _tstamp = json['_tstamp'];
        _user = json['_user'];
        _env = json['_env'];
        _uri = json['_uri'];
        _query = json['_query'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        '_xmlns': _xmlns,
        '_type': _type,
        '_source': _source,
        '_tstamp': _tstamp,
        '_user': _user,
        '_env': _env,
        '_uri': _uri,
        '_query': _query
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

class status implements IConvertible
{
    String? errorCode;
    String? validationStatusCode;
    int? statusId;
    String? errorDescription;
    String? statusDescription;

    status({this.errorCode,this.validationStatusCode,this.statusId,this.errorDescription,this.statusDescription});
    status.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        errorCode = json['errorCode'];
        validationStatusCode = json['validationStatusCode'];
        statusId = json['statusId'];
        errorDescription = json['errorDescription'];
        statusDescription = json['statusDescription'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'errorCode': errorCode,
        'validationStatusCode': validationStatusCode,
        'statusId': statusId,
        'errorDescription': errorDescription,
        'statusDescription': statusDescription
    };

    getTypeName() => "status";
    TypeContext? context = _ctx;
}

class suggestion implements IConvertible
{
    String? zipCode;
    String? regionId;
    String? regionDescription;
    String? city;
    String? street;
    String? houseNumber;
    String? countryId;
    String? countryDescription;

    suggestion({this.zipCode,this.regionId,this.regionDescription,this.city,this.street,this.houseNumber,this.countryId,this.countryDescription});
    suggestion.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        zipCode = json['zipCode'];
        regionId = json['regionId'];
        regionDescription = json['regionDescription'];
        city = json['city'];
        street = json['street'];
        houseNumber = json['houseNumber'];
        countryId = json['countryId'];
        countryDescription = json['countryDescription'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'zipCode': zipCode,
        'regionId': regionId,
        'regionDescription': regionDescription,
        'city': city,
        'street': street,
        'houseNumber': houseNumber,
        'countryId': countryId,
        'countryDescription': countryDescription
    };

    getTypeName() => "suggestion";
    TypeContext? context = _ctx;
}

class ValidatePostalAddressResponse extends BaseResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    status? status;
    suggestion? suggestion;

    ValidatePostalAddressResponse({this.ResponseStatus,this.status,this.suggestion});
    ValidatePostalAddressResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        status = JsonConverters.fromJson(json['status'],'status',context!);
        suggestion = JsonConverters.fromJson(json['suggestion'],'suggestion',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'status': JsonConverters.toJson(status,'status',context!),
        'suggestion': JsonConverters.toJson(suggestion,'suggestion',context!)
    });

    getTypeName() => "ValidatePostalAddressResponse";
    TypeContext? context = _ctx;
}

class ValidatePostalAddress extends BaseRequest<ValidatePostalAddressResponse> implements IConvertible
{
    String? zipCode;
    String? region;
    String? city;
    String? street;
    String? houseNumber;
    String? countryId;

    ValidatePostalAddress({this.zipCode,this.region,this.city,this.street,this.houseNumber,this.countryId});
    ValidatePostalAddress.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        zipCode = json['zipCode'];
        region = json['region'];
        city = json['city'];
        street = json['street'];
        houseNumber = json['houseNumber'];
        countryId = json['countryId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'zipCode': zipCode,
        'region': region,
        'city': city,
        'street': street,
        'houseNumber': houseNumber,
        'countryId': countryId
    });

    getTypeName() => "ValidatePostalAddress";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'qp_microservices_booster.richemont.com', types: <String, TypeInfo> {
    'BaseRequest<TResponse>': TypeInfo(TypeOf.Class, create:() => BaseRequest<TResponse>()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'status': TypeInfo(TypeOf.Class, create:() => status()),
    'suggestion': TypeInfo(TypeOf.Class, create:() => suggestion()),
    'ValidatePostalAddressResponse': TypeInfo(TypeOf.Class, create:() => ValidatePostalAddressResponse()),
    'ValidatePostalAddress': TypeInfo(TypeOf.Class, create:() => ValidatePostalAddress()),
});

Dart ValidatePostalAddress DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ValidatePostalAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_appVersion xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_appVersion>
  <_os xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_os>
  <_searchMethod xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_searchMethod>
  <app xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</app>
  <sid xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</sid>
  <city>String</city>
  <countryId>String</countryId>
  <houseNumber>String</houseNumber>
  <region>String</region>
  <street>String</street>
  <zipCode>String</zipCode>
</ValidatePostalAddress>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ValidatePostalAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_env xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_env>
  <_query xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_query>
  <_source xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_source>
  <_tstamp xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_tstamp>
  <_type xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_type>
  <_uri xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_uri>
  <_user xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_user>
  <_xmlns xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_xmlns>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <status>
    <errorCode>String</errorCode>
    <errorDescription>String</errorDescription>
    <statusDescription>String</statusDescription>
    <statusId>0</statusId>
    <validationStatusCode>String</validationStatusCode>
  </status>
  <suggestion>
    <city>String</city>
    <countryDescription>String</countryDescription>
    <countryId>String</countryId>
    <houseNumber>String</houseNumber>
    <regionDescription>String</regionDescription>
    <regionId>String</regionId>
    <street>String</street>
    <zipCode>String</zipCode>
  </suggestion>
</ValidatePostalAddressResponse>