Billhighway Cloud API

<back to all web services

ExchangeRateBaseParams

The following routes are available for this service:
POST/api/Financial/ExchangeRateBase
import Foundation
import ServiceStack

public class ExchangeRateBaseParams : ExchangeRateBaseParams
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ExchangeRateBase : Codable
{
    public var exchangeRate:ExchangeRate?
    public var baseAmount:Double?

    required public init(){}
}

public class ExchangeRate : ILazyLoadMemoryCacheValue, Codable
{
    public var baseCurrency:String?
    public var foreignCurrency:String?
    public var rate:Double?
    public var timeStamp:Date?
    public var fromCache:Bool?

    required public init(){}
}


Swift ExchangeRateBaseParams 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 /api/Financial/ExchangeRateBase HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExchangeRateBaseParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AmountDue xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</AmountDue>
  <BaseCurrency xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</BaseCurrency>
  <ProcessingCurrency xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ProcessingCurrency>
</ExchangeRateBaseParams>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExchangeRateBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <BaseAmount>0</BaseAmount>
  <ExchangeRate>
    <BaseCurrency>String</BaseCurrency>
    <ForeignCurrency>String</ForeignCurrency>
    <FromCache>false</FromCache>
    <Rate>0</Rate>
    <TimeStamp>0001-01-01T00:00:00</TimeStamp>
  </ExchangeRate>
</ExchangeRateBase>