Billhighway Cloud API

<back to all web services

SubscriptionFormAccessRq

The following routes are available for this service:
POST/signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/form/access/link
import 'package:servicestack/servicestack.dart';

class SubscriptionFormAccessRq implements IConvertible
{
    int? NatID;
    int? GroupID;
    int? UserID;
    String? UserType;
    int? AdminID;
    int? SubscriptionInvoiceID;
    int? SubscriptionLineageID;
    String? ClientSubscriberId;
    int? MemberSubscriptionInvId;
    bool? IsPrintView;
    bool? IsBillMeLaterSubscription;
    int? RenewedMemberSubscriptionInvID;
    bool? IsRenewal;
    int? ClientSubscriptionTypeID;

    SubscriptionFormAccessRq({this.NatID,this.GroupID,this.UserID,this.UserType,this.AdminID,this.SubscriptionInvoiceID,this.SubscriptionLineageID,this.ClientSubscriberId,this.MemberSubscriptionInvId,this.IsPrintView,this.IsBillMeLaterSubscription,this.RenewedMemberSubscriptionInvID,this.IsRenewal,this.ClientSubscriptionTypeID});
    SubscriptionFormAccessRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NatID = json['NatID'];
        GroupID = json['GroupID'];
        UserID = json['UserID'];
        UserType = json['UserType'];
        AdminID = json['AdminID'];
        SubscriptionInvoiceID = json['SubscriptionInvoiceID'];
        SubscriptionLineageID = json['SubscriptionLineageID'];
        ClientSubscriberId = json['ClientSubscriberId'];
        MemberSubscriptionInvId = json['MemberSubscriptionInvId'];
        IsPrintView = json['IsPrintView'];
        IsBillMeLaterSubscription = json['IsBillMeLaterSubscription'];
        RenewedMemberSubscriptionInvID = json['RenewedMemberSubscriptionInvID'];
        IsRenewal = json['IsRenewal'];
        ClientSubscriptionTypeID = json['ClientSubscriptionTypeID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NatID': NatID,
        'GroupID': GroupID,
        'UserID': UserID,
        'UserType': UserType,
        'AdminID': AdminID,
        'SubscriptionInvoiceID': SubscriptionInvoiceID,
        'SubscriptionLineageID': SubscriptionLineageID,
        'ClientSubscriberId': ClientSubscriberId,
        'MemberSubscriptionInvId': MemberSubscriptionInvId,
        'IsPrintView': IsPrintView,
        'IsBillMeLaterSubscription': IsBillMeLaterSubscription,
        'RenewedMemberSubscriptionInvID': RenewedMemberSubscriptionInvID,
        'IsRenewal': IsRenewal,
        'ClientSubscriptionTypeID': ClientSubscriptionTypeID
    };

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

class LinkResponse implements IConvertible
{
    String? Rel;
    String? Uri;

    LinkResponse({this.Rel,this.Uri});
    LinkResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Rel = json['Rel'];
        Uri = json['Uri'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Rel': Rel,
        'Uri': Uri
    };

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'SubscriptionFormAccessRq': TypeInfo(TypeOf.Class, create:() => SubscriptionFormAccessRq()),
    'LinkResponse': TypeInfo(TypeOf.Class, create:() => LinkResponse()),
});

Dart SubscriptionFormAccessRq 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 /signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/form/access/link HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubscriptionFormAccessRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.Subscriptions">
  <AdminID>0</AdminID>
  <ClientSubscriberId>String</ClientSubscriberId>
  <ClientSubscriptionTypeID>0</ClientSubscriptionTypeID>
  <GroupID>0</GroupID>
  <IsBillMeLaterSubscription>false</IsBillMeLaterSubscription>
  <IsPrintView>false</IsPrintView>
  <IsRenewal>false</IsRenewal>
  <MemberSubscriptionInvId>0</MemberSubscriptionInvId>
  <NatID>0</NatID>
  <RenewedMemberSubscriptionInvID>0</RenewedMemberSubscriptionInvID>
  <SubscriptionInvoiceID>0</SubscriptionInvoiceID>
  <SubscriptionLineageID>0</SubscriptionLineageID>
  <UserID>0</UserID>
  <UserType>String</UserType>
</SubscriptionFormAccessRq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <Rel>String</Rel>
  <Uri>String</Uri>
</LinkResponse>