Billhighway Cloud API

<back to all web services

crmRequest

namespace BH.CloudAPI.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ResultCode =
        | Success = 0
        | Duplicate = -7
        | NotAvailable = -6
        | NotFound = -5
        | GeneralError = -4
        | UnexpectedError = -3
        | CreditCardDeclined = -2
        | DataValidationFailure = -1

    [<DataContract(Namespace="www.billhighway.com/api")>]
    [<AllowNullLiteral>]
    type LegacyApiResponse() = 
        [<DataMember>]
        member val amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val confirmationNumber:String = null with get,set

        [<DataMember>]
        member val responseCode:String = null with get,set

        [<DataMember>]
        member val responseDescription:String = null with get,set

        [<DataMember>]
        member val resultCode:ResultCode = new ResultCode() with get,set

    [<DataContract(Namespace="www.billhighway.com/api")>]
    [<AllowNullLiteral>]
    type crmRequestResponse() = 
        [<DataMember>]
        member val crmRequestResult:LegacyApiResponse = null with get,set

    [<AllowNullLiteral>]
    type crmRequest() = 
        inherit crmRequest()

F# crmRequest 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 /jsv/reply/crmRequest HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

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