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 Foundation
import ServiceStack

public class StandardSignupFormInfoGetRq : IApiRequest, Codable
{
    public var natID:Int?
    public var groupId:Int?
    public var userId:String?
    public var userType:String?

    required public init(){}
}

public class StandardSignupFormInfoGetRs : IApiResponse, Codable
{
    public var standardSignupFormInfo:StandardSignupFormInfo?
    public var links:[Link] = []

    required public init(){}
}

public class StandardSignupFormInfo : Codable
{
    public var contextualHelp:[ContextualHelpDto] = []
    public var countries:[CountryDto] = []
    public var states:[StateDto] = []
    public var chapters:[ChapterDto] = []
    public var memberTypes:[MemberType] = []

    required public init(){}
}

public class ContextualHelpDto : Codable
{
    public var controlName:String?
    public var labelText:String?
    public var isVisible:Bool?
    public var isRequired:Bool?

    required public init(){}
}

public class CountryDto : Codable
{
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class StateDto : Codable
{
    public var stateID:Int?
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class ChapterDto : Codable
{
    public var chapId:Int?
    public var college:String?
    public var designation:String?

    required public init(){}
}

public class MemberType : Codable
{
    public var memTypeId:Int?
    public var nationalId:Int?
    public var chapId:Int?
    public var Description:String?
    public var isPrimary:Bool?

    required public init(){}
}

public class Link : Codable
{
    public var rel:String?
    public var url:String?

    required public init(){}
}


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