Billhighway Cloud API

<back to all web services

crmRequest

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

namespace BH.CloudAPI.Common
{
    [DataContract(Namespace="www.billhighway.com/api")]
    public partial class LegacyApiResponse
        : IHaveErrorField
    {
        [DataMember]
        public virtual decimal? amount { get; set; }

        [DataMember]
        public virtual string confirmationNumber { get; set; }

        [DataMember]
        public virtual string responseCode { get; set; }

        [DataMember]
        public virtual string responseDescription { get; set; }

        [DataMember]
        public virtual ResultCode resultCode { get; set; }
    }

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

}

namespace BH.CloudAPI.Common.DTO.SOAP
{
    [DataContract(Namespace="www.billhighway.com/api")]
    public partial class crmRequestResponse
        : IHaveErrorField
    {
        [DataMember]
        public virtual LegacyApiResponse crmRequestResult { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.SOAP
{
    public partial class crmRequest
        : crmRequest
    {
    }

}

C# 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>