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
SubscriptionFormAccessRq Parameters:
NameParameterData TypeRequiredDescription
NatIDpathintNo
GroupIDpathintNo
UserIDpathintNo
UserTypepathstringNo
AdminIDbodyintNo
SubscriptionInvoiceIDbodylongNo
SubscriptionLineageIDbodylongNo
ClientSubscriberIdbodystringNo
MemberSubscriptionInvIdbodyintNo
IsPrintViewbodyboolNo
IsBillMeLaterSubscriptionbodyboolNo
RenewedMemberSubscriptionInvIDbodylongNo
IsRenewalbodyboolNo
ClientSubscriptionTypeIDbodyintNo
LinkResponse Parameters:
NameParameterData TypeRequiredDescription
RelformstringNo
UriformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NatID: 0,
	GroupID: 0,
	UserID: 0,
	UserType: String,
	AdminID: 0,
	SubscriptionInvoiceID: 0,
	SubscriptionLineageID: 0,
	ClientSubscriberId: String,
	MemberSubscriptionInvId: 0,
	IsPrintView: False,
	IsBillMeLaterSubscription: False,
	RenewedMemberSubscriptionInvID: 0,
	IsRenewal: False,
	ClientSubscriptionTypeID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rel: String,
	Uri: String
}