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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class StandardSignupFormInfoGetRq : IApiRequest
{
    var NatID:Int? = null
    var GroupId:Int? = null
    var UserId:String? = null
    var UserType:String? = null
}

open class StandardSignupFormInfoGetRs : IApiResponse
{
    var StandardSignupFormInfo:StandardSignupFormInfo? = null
    var Links:ArrayList<Link> = ArrayList<Link>()
}

open class StandardSignupFormInfo
{
    var ContextualHelp:ArrayList<ContextualHelpDto> = ArrayList<ContextualHelpDto>()
    var Countries:ArrayList<CountryDto> = ArrayList<CountryDto>()
    var States:ArrayList<StateDto> = ArrayList<StateDto>()
    var Chapters:ArrayList<ChapterDto> = ArrayList<ChapterDto>()
    var MemberTypes:ArrayList<MemberType> = ArrayList<MemberType>()
}

open class ContextualHelpDto
{
    var ControlName:String? = null
    var LabelText:String? = null
    var IsVisible:Boolean? = null
    var IsRequired:Boolean? = null
}

open class CountryDto
{
    var CountryID:Int? = null
    var FullName:String? = null
    var Abbr:String? = null
}

open class StateDto
{
    var StateID:Int? = null
    var CountryID:Int? = null
    var FullName:String? = null
    var Abbr:String? = null
}

open class ChapterDto
{
    var ChapId:Int? = null
    var College:String? = null
    var Designation:String? = null
}

open class MemberType
{
    var MemTypeId:Int? = null
    var NationalId:Int? = null
    var ChapId:Int? = null
    var Description:String? = null
    var IsPrimary:Boolean? = null
}

open class Link
{
    var Rel:String? = null
    var Url:String? = null
}

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