Booster.Microservices

<back to all web services

ValidatePhoneNumber

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

public class ValidatePhoneNumber : BaseRequest<ValidatePhoneNumberResponse>
{
    public var phoneNumber:String
    public var countryId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case phoneNumber
        case countryId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if phoneNumber != nil { try container.encode(phoneNumber, forKey: .phoneNumber) }
        if countryId != nil { try container.encode(countryId, forKey: .countryId) }
    }
}

public class BaseRequest<TResponse : Codable> : IRequest, Codable
{
    public var sid:String
    public var app:String
    public var _os:String
    public var _appVersion:String
    public var _searchMethod:String

    required public init(){}
}

public class ValidatePhoneNumberResponse : BaseResponse
{
    public var responseStatus:ResponseStatus
    public var isValid:Bool?
    public var countryId:String
    public var nationalNumber:String
    public var nationalFormat:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case responseStatus
        case isValid
        case countryId
        case nationalNumber
        case nationalFormat
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
        isValid = try container.decodeIfPresent(Bool.self, forKey: .isValid)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
        nationalNumber = try container.decodeIfPresent(String.self, forKey: .nationalNumber)
        nationalFormat = try container.decodeIfPresent(String.self, forKey: .nationalFormat)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
        if isValid != nil { try container.encode(isValid, forKey: .isValid) }
        if countryId != nil { try container.encode(countryId, forKey: .countryId) }
        if nationalNumber != nil { try container.encode(nationalNumber, forKey: .nationalNumber) }
        if nationalFormat != nil { try container.encode(nationalFormat, forKey: .nationalFormat) }
    }
}

public class BaseResponse : IRespose, Codable
{
    public var _xmlns:String
    public var _type:String
    public var _source:String
    public var _tstamp:String
    public var _user:String
    public var _env:String
    public var _uri:String
    public var _query:String

    required public init(){}
}


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