Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;

namespace BH.CloudAPI.Common4.DTO
{
    public partial class MemberSubscription
    {
        public virtual string UniqueId { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserID { get; set; }
        public virtual string ClientCompanyID { get; set; }
        public virtual long ClientOrderID { get; set; }
        public virtual long ClientMemberSubscriberID { get; set; }
        public virtual string ClientSubscriptionTemplate { get; set; }
        public virtual long SubscriptionID { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
    }

    public partial class MemberSubscriptionCollection
    {
        public MemberSubscriptionCollection()
        {
            MemberSubscriptions = new List<MemberSubscription>{};
        }

        public virtual List<MemberSubscription> MemberSubscriptions { get; set; }
    }

    public partial class MemberSubscriptionReply
    {
        public virtual string UniqueId { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int MemberSubscriptionInvoiceId { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
    }

    public partial class MemberSubscriptionReplyCollection
        : IHaveErrorField
    {
        public MemberSubscriptionReplyCollection()
        {
            MemberSubscriptionReply = new List<MemberSubscriptionReply>{};
        }

        public virtual List<MemberSubscriptionReply> MemberSubscriptionReply { get; set; }
        public virtual bool IsError { get; set; }
    }

}

C# MemberSubscriptionCollection 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 /subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberSubscriptionCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <MemberSubscriptions>
    <MemberSubscription>
      <ClientCompanyID>String</ClientCompanyID>
      <ClientId>0</ClientId>
      <ClientMemberSubscriberID>0</ClientMemberSubscriberID>
      <ClientOrderID>0</ClientOrderID>
      <ClientSubscriptionTemplate>String</ClientSubscriptionTemplate>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <GroupId>String</GroupId>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <SubscriptionID>0</SubscriptionID>
      <UniqueId>String</UniqueId>
      <UserID>String</UserID>
    </MemberSubscription>
  </MemberSubscriptions>
</MemberSubscriptionCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberSubscriptionReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <MemberSubscriptionReply>
    <MemberSubscriptionReply>
      <ClientId>0</ClientId>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <MemberSubscriptionInvoiceId>0</MemberSubscriptionInvoiceId>
      <UniqueId>String</UniqueId>
    </MemberSubscriptionReply>
  </MemberSubscriptionReply>
</MemberSubscriptionReplyCollection>