Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription
import 'package:servicestack/servicestack.dart';

class MemberSubscription implements IConvertible
{
    String? UniqueId;
    int? ClientId;
    String? GroupId;
    String? UserID;
    String? ClientCompanyID;
    int? ClientOrderID;
    int? ClientMemberSubscriberID;
    String? ClientSubscriptionTemplate;
    int? SubscriptionID;
    DateTime? StartDate;
    DateTime? EndDate;

    MemberSubscription({this.UniqueId,this.ClientId,this.GroupId,this.UserID,this.ClientCompanyID,this.ClientOrderID,this.ClientMemberSubscriberID,this.ClientSubscriptionTemplate,this.SubscriptionID,this.StartDate,this.EndDate});
    MemberSubscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UniqueId = json['UniqueId'];
        ClientId = json['ClientId'];
        GroupId = json['GroupId'];
        UserID = json['UserID'];
        ClientCompanyID = json['ClientCompanyID'];
        ClientOrderID = json['ClientOrderID'];
        ClientMemberSubscriberID = json['ClientMemberSubscriberID'];
        ClientSubscriptionTemplate = json['ClientSubscriptionTemplate'];
        SubscriptionID = json['SubscriptionID'];
        StartDate = JsonConverters.fromJson(json['StartDate'],'DateTime',context!);
        EndDate = JsonConverters.fromJson(json['EndDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UniqueId': UniqueId,
        'ClientId': ClientId,
        'GroupId': GroupId,
        'UserID': UserID,
        'ClientCompanyID': ClientCompanyID,
        'ClientOrderID': ClientOrderID,
        'ClientMemberSubscriberID': ClientMemberSubscriberID,
        'ClientSubscriptionTemplate': ClientSubscriptionTemplate,
        'SubscriptionID': SubscriptionID,
        'StartDate': JsonConverters.toJson(StartDate,'DateTime',context!),
        'EndDate': JsonConverters.toJson(EndDate,'DateTime',context!)
    };

    getTypeName() => "MemberSubscription";
    TypeContext? context = _ctx;
}

class MemberSubscriptionCollection implements IConvertible
{
    List<MemberSubscription>? MemberSubscriptions;

    MemberSubscriptionCollection({this.MemberSubscriptions});
    MemberSubscriptionCollection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MemberSubscriptions = JsonConverters.fromJson(json['MemberSubscriptions'],'List<MemberSubscription>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MemberSubscriptions': JsonConverters.toJson(MemberSubscriptions,'List<MemberSubscription>',context!)
    };

    getTypeName() => "MemberSubscriptionCollection";
    TypeContext? context = _ctx;
}

class MemberSubscriptionReply implements IConvertible
{
    String? UniqueId;
    int? ClientId;
    int? MemberSubscriptionInvoiceId;
    int? ErrorCode;
    String? ErrorMessage;

    MemberSubscriptionReply({this.UniqueId,this.ClientId,this.MemberSubscriptionInvoiceId,this.ErrorCode,this.ErrorMessage});
    MemberSubscriptionReply.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UniqueId = json['UniqueId'];
        ClientId = json['ClientId'];
        MemberSubscriptionInvoiceId = json['MemberSubscriptionInvoiceId'];
        ErrorCode = json['ErrorCode'];
        ErrorMessage = json['ErrorMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UniqueId': UniqueId,
        'ClientId': ClientId,
        'MemberSubscriptionInvoiceId': MemberSubscriptionInvoiceId,
        'ErrorCode': ErrorCode,
        'ErrorMessage': ErrorMessage
    };

    getTypeName() => "MemberSubscriptionReply";
    TypeContext? context = _ctx;
}

class MemberSubscriptionReplyCollection implements IHaveErrorField, IConvertible
{
    List<MemberSubscriptionReply>? MemberSubscriptionReply;
    bool? IsError;

    MemberSubscriptionReplyCollection({this.MemberSubscriptionReply,this.IsError});
    MemberSubscriptionReplyCollection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MemberSubscriptionReply = JsonConverters.fromJson(json['MemberSubscriptionReply'],'List<MemberSubscriptionReply>',context!);
        IsError = json['IsError'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MemberSubscriptionReply': JsonConverters.toJson(MemberSubscriptionReply,'List<MemberSubscriptionReply>',context!),
        'IsError': IsError
    };

    getTypeName() => "MemberSubscriptionReplyCollection";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'MemberSubscription': TypeInfo(TypeOf.Class, create:() => MemberSubscription()),
    'MemberSubscriptionCollection': TypeInfo(TypeOf.Class, create:() => MemberSubscriptionCollection()),
    'List<MemberSubscription>': TypeInfo(TypeOf.Class, create:() => <MemberSubscription>[]),
    'MemberSubscriptionReply': TypeInfo(TypeOf.Class, create:() => MemberSubscriptionReply()),
    'MemberSubscriptionReplyCollection': TypeInfo(TypeOf.Class, create:() => MemberSubscriptionReplyCollection()),
    'List<MemberSubscriptionReply>': TypeInfo(TypeOf.Class, create:() => <MemberSubscriptionReply>[]),
});

Dart 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>