Billhighway Cloud API

<back to all web services

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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/crmRequest HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"apiKey":"String","featureID":0,"clientID":0,"groupID":0,"activityID":0,"docNo":0,"docTypeID":0,"crmInfo":"String"}

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

{"crmRequestResult":{"amount":0,"confirmationNumber":"String","responseCode":"String","responseDescription":"String","resultCode":0}}