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
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SubscriptionFormAccessRq() = 
        member val NatID:Int32 = new Int32() with get,set
        member val GroupID:Int32 = new Int32() with get,set
        member val UserID:Int32 = new Int32() with get,set
        member val UserType:String = null with get,set
        member val AdminID:Int32 = new Int32() with get,set
        member val SubscriptionInvoiceID:Int64 = new Int64() with get,set
        member val SubscriptionLineageID:Int64 = new Int64() with get,set
        member val ClientSubscriberId:String = null with get,set
        member val MemberSubscriptionInvId:Int32 = new Int32() with get,set
        member val IsPrintView:Boolean = new Boolean() with get,set
        member val IsBillMeLaterSubscription:Boolean = new Boolean() with get,set
        member val RenewedMemberSubscriptionInvID:Int64 = new Int64() with get,set
        member val IsRenewal:Boolean = new Boolean() with get,set
        member val ClientSubscriptionTypeID:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type LinkResponse() = 
        member val Rel:String = null with get,set
        member val Uri:String = null with get,set

F# SubscriptionFormAccessRq DTOs

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

HTTP + CSV

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

{"Rel":"String","Uri":"String"}