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.*


open class SubscriptionFormAccessRq
{
    var NatID:Int? = null
    var GroupID:Int? = null
    var UserID:Int? = null
    var UserType:String? = null
    var AdminID:Int? = null
    var SubscriptionInvoiceID:Long? = null
    var SubscriptionLineageID:Long? = null
    var ClientSubscriberId:String? = null
    var MemberSubscriptionInvId:Int? = null
    var IsPrintView:Boolean? = null
    var IsBillMeLaterSubscription:Boolean? = null
    var RenewedMemberSubscriptionInvID:Long? = null
    var IsRenewal:Boolean? = null
    var ClientSubscriptionTypeID:Int? = null
}

open class LinkResponse
{
    var Rel:String? = null
    var Uri:String? = null
}

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