Billhighway Cloud API

crmRequest

import Foundation
import ServiceStack

public class crmRequest : crmRequest
{
    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)
    }
}

// @DataContract(Namespace="www.billhighway.com/api")
public class crmRequestResponse : IHaveErrorField, Codable
{
    // @DataMember
    public var crmRequestResult:LegacyApiResponse?

    required public init(){}
}

// @DataContract(Namespace="www.billhighway.com/api")
public class LegacyApiResponse : IHaveErrorField, Codable
{
    // @DataMember
    public var amount:Double?

    // @DataMember
    public var confirmationNumber:String?

    // @DataMember
    public var responseCode:String?

    // @DataMember
    public var responseDescription:String?

    // @DataMember
    public var resultCode:ResultCode?

    required public init(){}
}

public enum ResultCode : Int, Codable
{
    case Success = 0
    case Duplicate = -7
    case NotAvailable = -6
    case NotFound = -5
    case GeneralError = -4
    case UnexpectedError = -3
    case CreditCardDeclined = -2
    case DataValidationFailure = -1
}

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

<crmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <activityID xmlns="www.billhighway.com/api">0</activityID>
  <docNo xmlns="www.billhighway.com/api">0</docNo>
  <docTypeID xmlns="www.billhighway.com/api">0</docTypeID>
  <crmInfo xmlns="www.billhighway.com/api">String</crmInfo>
</crmRequest>

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

<crmRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <crmRequestResult>
    <amount>0</amount>
    <confirmationNumber>String</confirmationNumber>
    <responseCode>String</responseCode>
    <responseDescription>String</responseDescription>
    <resultCode>Success</resultCode>
  </crmRequestResult>
</crmRequestResponse>