Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

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

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class MemberSubscription
            Public Overridable Property UniqueId As String
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserID As String
            Public Overridable Property ClientCompanyID As String
            Public Overridable Property ClientOrderID As Long
            Public Overridable Property ClientMemberSubscriberID As Long
            Public Overridable Property ClientSubscriptionTemplate As String
            Public Overridable Property SubscriptionID As Long
            Public Overridable Property StartDate As Nullable(Of Date)
            Public Overridable Property EndDate As Nullable(Of Date)
        End Class

        Public Partial Class MemberSubscriptionCollection
            Public Sub New()
                MemberSubscriptions = New List(Of MemberSubscription)
            End Sub

            Public Overridable Property MemberSubscriptions As List(Of MemberSubscription)
        End Class

        Public Partial Class MemberSubscriptionReply
            Public Overridable Property UniqueId As String
            Public Overridable Property ClientId As Integer
            Public Overridable Property MemberSubscriptionInvoiceId As Integer
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
        End Class

        Public Partial Class MemberSubscriptionReplyCollection
            Implements IHaveErrorField
            Public Sub New()
                MemberSubscriptionReply = New List(Of MemberSubscriptionReply)
            End Sub

            Public Overridable Property MemberSubscriptionReply As List(Of MemberSubscriptionReply)
            Public Overridable Property IsError As Boolean
        End Class
    End Namespace
End Namespace

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