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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SubscriptionFormAccessRq
    {
        public Integer NatID = null;
        public Integer GroupID = null;
        public Integer UserID = null;
        public String UserType = null;
        public Integer AdminID = null;
        public Long SubscriptionInvoiceID = null;
        public Long SubscriptionLineageID = null;
        public String ClientSubscriberId = null;
        public Integer MemberSubscriptionInvId = null;
        public Boolean IsPrintView = null;
        public Boolean IsBillMeLaterSubscription = null;
        public Long RenewedMemberSubscriptionInvID = null;
        public Boolean IsRenewal = null;
        public Integer ClientSubscriptionTypeID = null;
        
        public Integer getNatID() { return NatID; }
        public SubscriptionFormAccessRq setNatID(Integer value) { this.NatID = value; return this; }
        public Integer getGroupID() { return GroupID; }
        public SubscriptionFormAccessRq setGroupID(Integer value) { this.GroupID = value; return this; }
        public Integer getUserID() { return UserID; }
        public SubscriptionFormAccessRq setUserID(Integer value) { this.UserID = value; return this; }
        public String getUserType() { return UserType; }
        public SubscriptionFormAccessRq setUserType(String value) { this.UserType = value; return this; }
        public Integer getAdminID() { return AdminID; }
        public SubscriptionFormAccessRq setAdminID(Integer value) { this.AdminID = value; return this; }
        public Long getSubscriptionInvoiceID() { return SubscriptionInvoiceID; }
        public SubscriptionFormAccessRq setSubscriptionInvoiceID(Long value) { this.SubscriptionInvoiceID = value; return this; }
        public Long getSubscriptionLineageID() { return SubscriptionLineageID; }
        public SubscriptionFormAccessRq setSubscriptionLineageID(Long value) { this.SubscriptionLineageID = value; return this; }
        public String getClientSubscriberId() { return ClientSubscriberId; }
        public SubscriptionFormAccessRq setClientSubscriberId(String value) { this.ClientSubscriberId = value; return this; }
        public Integer getMemberSubscriptionInvId() { return MemberSubscriptionInvId; }
        public SubscriptionFormAccessRq setMemberSubscriptionInvId(Integer value) { this.MemberSubscriptionInvId = value; return this; }
        public Boolean getIsPrintView() { return IsPrintView; }
        public SubscriptionFormAccessRq setIsPrintView(Boolean value) { this.IsPrintView = value; return this; }
        public Boolean getIsBillMeLaterSubscription() { return IsBillMeLaterSubscription; }
        public SubscriptionFormAccessRq setIsBillMeLaterSubscription(Boolean value) { this.IsBillMeLaterSubscription = value; return this; }
        public Long getRenewedMemberSubscriptionInvID() { return RenewedMemberSubscriptionInvID; }
        public SubscriptionFormAccessRq setRenewedMemberSubscriptionInvID(Long value) { this.RenewedMemberSubscriptionInvID = value; return this; }
        public Boolean getIsRenewal() { return IsRenewal; }
        public SubscriptionFormAccessRq setIsRenewal(Boolean value) { this.IsRenewal = value; return this; }
        public Integer getClientSubscriptionTypeID() { return ClientSubscriptionTypeID; }
        public SubscriptionFormAccessRq setClientSubscriptionTypeID(Integer value) { this.ClientSubscriptionTypeID = value; return this; }
    }

    public static class LinkResponse
    {
        public String Rel = null;
        public String Uri = null;
        
        public String getRel() { return Rel; }
        public LinkResponse setRel(String value) { this.Rel = value; return this; }
        public String getUri() { return Uri; }
        public LinkResponse setUri(String value) { this.Uri = value; return this; }
    }

}

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