Billhighway Cloud API

KeyRequest

The following routes are available for this service:
POST	/api/keys/generate

import Foundation
import ServiceStack

public class KeyRequest : KeyRequest
{
    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 KeyResult : IHaveErrorField, Codable
{
    public var keyNameValuePairs:[String:Int] = [:]
    public var isSuccessful:Bool?
    public var errorCode:Int?
    public var message:String?
    public var isError:Bool?

    required public init(){}
}

Swift KeyRequest 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/keys/generate HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <DbName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</DbName>
  <Keys xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Keys>
      <Name>String</Name>
      <NumberRequested>0</NumberRequested>
    </Keys>
  </Keys>
</KeyRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KeyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ErrorCode>0</ErrorCode>
  <IsSuccessful>false</IsSuccessful>
  <KeyNameValuePairs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringlong>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringlong>
  </KeyNameValuePairs>
  <Message>String</Message>
</KeyResult>