Billhighway Cloud API

<back to all web services

StandardSignupFormInfoGetRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/standardSignup/info
GET/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/standardSignup/info
namespace BH.API.CloudApi.Core

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

    [<AllowNullLiteral>]
    type StandardSignupFormInfoGetRq() = 
        member val NatID:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val UserType:String = null with get,set

    [<AllowNullLiteral>]
    type ContextualHelpDto() = 
        member val ControlName:String = null with get,set
        member val LabelText:String = null with get,set
        member val IsVisible:Boolean = new Boolean() with get,set
        member val IsRequired:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CountryDto() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val FullName:String = null with get,set
        member val Abbr:String = null with get,set

    [<AllowNullLiteral>]
    type StateDto() = 
        member val StateID:Int32 = new Int32() with get,set
        member val CountryID:Int32 = new Int32() with get,set
        member val FullName:String = null with get,set
        member val Abbr:String = null with get,set

    [<AllowNullLiteral>]
    type ChapterDto() = 
        member val ChapId:Int32 = new Int32() with get,set
        member val College:String = null with get,set
        member val Designation:String = null with get,set

    [<AllowNullLiteral>]
    type MemberType() = 
        member val MemTypeId:Int32 = new Int32() with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapId:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val IsPrimary:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StandardSignupFormInfo() = 
        member val ContextualHelp:ResizeArray<ContextualHelpDto> = new ResizeArray<ContextualHelpDto>() with get,set
        member val Countries:ResizeArray<CountryDto> = new ResizeArray<CountryDto>() with get,set
        member val States:ResizeArray<StateDto> = new ResizeArray<StateDto>() with get,set
        member val Chapters:ResizeArray<ChapterDto> = new ResizeArray<ChapterDto>() with get,set
        member val MemberTypes:ResizeArray<MemberType> = new ResizeArray<MemberType>() with get,set

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

    [<AllowNullLiteral>]
    type StandardSignupFormInfoGetRs() = 
        member val StandardSignupFormInfo:StandardSignupFormInfo = null with get,set
        member val Links:ResizeArray<Link> = new ResizeArray<Link>() with get,set

F# StandardSignupFormInfoGetRq DTOs

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.

GET /signup/api/nat/{natID}/standardSignup/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StandardSignupFormInfo: 
	{
		ContextualHelp: 
		[
			{
				ControlName: String,
				LabelText: String,
				IsVisible: False,
				IsRequired: False
			}
		],
		Countries: 
		[
			{
				CountryID: 0,
				FullName: String,
				Abbr: String
			}
		],
		States: 
		[
			{
				StateID: 0,
				CountryID: 0,
				FullName: String,
				Abbr: String
			}
		],
		Chapters: 
		[
			{
				ChapId: 0,
				College: String,
				Designation: String
			}
		],
		MemberTypes: 
		[
			{
				MemTypeId: 0,
				NationalId: 0,
				ChapId: 0,
				Description: String,
				IsPrimary: False
			}
		]
	},
	Links: 
	[
		{
			Rel: String,
			Url: String
		}
	]
}