Billhighway Cloud API

SubscriptionFormAccessRq

The following routes are available for this service:
POST	/signup/api/nat/{natID}/group/{groupID}/{userType}/user/{userID}/form/access/link

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionFormAccessRq:
    nat_i_d: Optional[int] = None
    group_i_d: Optional[int] = None
    user_i_d: Optional[int] = None
    user_type: Optional[str] = None
    admin_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    subscription_lineage_i_d: Optional[int] = None
    client_subscriber_id: Optional[str] = None
    member_subscription_inv_id: Optional[int] = None
    is_print_view: Optional[bool] = None
    is_bill_me_later_subscription: Optional[bool] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None
    is_renewal: Optional[bool] = None
    client_subscription_type_i_d: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkResponse:
    rel: Optional[str] = None
    uri: Optional[str] = None

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