Billhighway Cloud API

crmRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.SOAP
Imports BH.CloudAPI.Common.DTO.SOAP
Imports BH.CloudAPI.Common

Namespace Global

    Namespace BH.CloudAPI.Common

        <DataContract(Namespace:="www.billhighway.com/api")>
        Public Partial Class LegacyApiResponse
            Implements IHaveErrorField
            <DataMember>
            Public Overridable Property amount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property confirmationNumber As String

            <DataMember>
            Public Overridable Property responseCode As String

            <DataMember>
            Public Overridable Property responseDescription As String

            <DataMember>
            Public Overridable Property resultCode As ResultCode
        End Class

        Public Enum ResultCode
            Success = 0
            Duplicate = -7
            NotAvailable = -6
            NotFound = -5
            GeneralError = -4
            UnexpectedError = -3
            CreditCardDeclined = -2
            DataValidationFailure = -1
        End Enum
    End Namespace

    Namespace BH.CloudAPI.Common.DTO.SOAP

        <DataContract(Namespace:="www.billhighway.com/api")>
        Public Partial Class crmRequestResponse
            Implements IHaveErrorField
            <DataMember>
            Public Overridable Property crmRequestResult As LegacyApiResponse
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SOAP

        Public Partial Class crmRequest
            Inherits crmRequest
        End Class
    End Namespace
End Namespace

VB.NET 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>