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
StandardSignupFormInfoGetRq Parameters:
NameParameterData TypeRequiredDescription
NatIDpathintNo
GroupIdpathintNo
UserIdpathstringNo
UserTypepathstringNo
StandardSignupFormInfoGetRs Parameters:
NameParameterData TypeRequiredDescription
StandardSignupFormInfoformStandardSignupFormInfoNo
LinksformList<Link>No
StandardSignupFormInfo Parameters:
NameParameterData TypeRequiredDescription
ContextualHelpformList<ContextualHelpDto>No
CountriesformList<CountryDto>No
StatesformList<StateDto>No
ChaptersformList<ChapterDto>No
MemberTypesformList<MemberType>No
ContextualHelpDto Parameters:
NameParameterData TypeRequiredDescription
ControlNameformstringNo
LabelTextformstringNo
IsVisibleformboolNo
IsRequiredformboolNo
CountryDto Parameters:
NameParameterData TypeRequiredDescription
CountryIDformintNo
FullNameformstringNo
AbbrformstringNo
StateDto Parameters:
NameParameterData TypeRequiredDescription
StateIDformintNo
CountryIDformintNo
FullNameformstringNo
AbbrformstringNo
ChapterDto Parameters:
NameParameterData TypeRequiredDescription
ChapIdformintNo
CollegeformstringNo
DesignationformstringNo
MemberType Parameters:
NameParameterData TypeRequiredDescription
MemTypeIdformintNo
NationalIdformintNo
ChapIdformintNo
DescriptionformstringNo
IsPrimaryformboolNo
Link Parameters:
NameParameterData TypeRequiredDescription
RelformstringNo
UrlformstringNo

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