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.*;

public class dtos
{

    public static class StandardSignupFormInfoGetRq implements IApiRequest
    {
        public Integer NatID = null;
        public Integer GroupId = null;
        public String UserId = null;
        public String UserType = null;
        
        public Integer getNatID() { return NatID; }
        public StandardSignupFormInfoGetRq setNatID(Integer value) { this.NatID = value; return this; }
        public Integer getGroupId() { return GroupId; }
        public StandardSignupFormInfoGetRq setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public StandardSignupFormInfoGetRq setUserId(String value) { this.UserId = value; return this; }
        public String getUserType() { return UserType; }
        public StandardSignupFormInfoGetRq setUserType(String value) { this.UserType = value; return this; }
    }

    public static class StandardSignupFormInfoGetRs implements IApiResponse
    {
        public StandardSignupFormInfo StandardSignupFormInfo = null;
        public ArrayList<Link> Links = null;
        
        public StandardSignupFormInfo getStandardSignupFormInfo() { return StandardSignupFormInfo; }
        public StandardSignupFormInfoGetRs setStandardSignupFormInfo(StandardSignupFormInfo value) { this.StandardSignupFormInfo = value; return this; }
        public ArrayList<Link> getLinks() { return Links; }
        public StandardSignupFormInfoGetRs setLinks(ArrayList<Link> value) { this.Links = value; return this; }
    }

    public static class StandardSignupFormInfo
    {
        public ArrayList<ContextualHelpDto> ContextualHelp = null;
        public ArrayList<CountryDto> Countries = null;
        public ArrayList<StateDto> States = null;
        public ArrayList<ChapterDto> Chapters = null;
        public ArrayList<MemberType> MemberTypes = null;
        
        public ArrayList<ContextualHelpDto> getContextualHelp() { return ContextualHelp; }
        public StandardSignupFormInfo setContextualHelp(ArrayList<ContextualHelpDto> value) { this.ContextualHelp = value; return this; }
        public ArrayList<CountryDto> getCountries() { return Countries; }
        public StandardSignupFormInfo setCountries(ArrayList<CountryDto> value) { this.Countries = value; return this; }
        public ArrayList<StateDto> getStates() { return States; }
        public StandardSignupFormInfo setStates(ArrayList<StateDto> value) { this.States = value; return this; }
        public ArrayList<ChapterDto> getChapters() { return Chapters; }
        public StandardSignupFormInfo setChapters(ArrayList<ChapterDto> value) { this.Chapters = value; return this; }
        public ArrayList<MemberType> getMemberTypes() { return MemberTypes; }
        public StandardSignupFormInfo setMemberTypes(ArrayList<MemberType> value) { this.MemberTypes = value; return this; }
    }

    public static class ContextualHelpDto
    {
        public String ControlName = null;
        public String LabelText = null;
        public Boolean IsVisible = null;
        public Boolean IsRequired = null;
        
        public String getControlName() { return ControlName; }
        public ContextualHelpDto setControlName(String value) { this.ControlName = value; return this; }
        public String getLabelText() { return LabelText; }
        public ContextualHelpDto setLabelText(String value) { this.LabelText = value; return this; }
        public Boolean getIsVisible() { return IsVisible; }
        public ContextualHelpDto setIsVisible(Boolean value) { this.IsVisible = value; return this; }
        public Boolean getIsRequired() { return IsRequired; }
        public ContextualHelpDto setIsRequired(Boolean value) { this.IsRequired = value; return this; }
    }

    public static class CountryDto
    {
        public Integer CountryID = null;
        public String FullName = null;
        public String Abbr = null;
        
        public Integer getCountryID() { return CountryID; }
        public CountryDto setCountryID(Integer value) { this.CountryID = value; return this; }
        public String getFullName() { return FullName; }
        public CountryDto setFullName(String value) { this.FullName = value; return this; }
        public String getAbbr() { return Abbr; }
        public CountryDto setAbbr(String value) { this.Abbr = value; return this; }
    }

    public static class StateDto
    {
        public Integer StateID = null;
        public Integer CountryID = null;
        public String FullName = null;
        public String Abbr = null;
        
        public Integer getStateID() { return StateID; }
        public StateDto setStateID(Integer value) { this.StateID = value; return this; }
        public Integer getCountryID() { return CountryID; }
        public StateDto setCountryID(Integer value) { this.CountryID = value; return this; }
        public String getFullName() { return FullName; }
        public StateDto setFullName(String value) { this.FullName = value; return this; }
        public String getAbbr() { return Abbr; }
        public StateDto setAbbr(String value) { this.Abbr = value; return this; }
    }

    public static class ChapterDto
    {
        public Integer ChapId = null;
        public String College = null;
        public String Designation = null;
        
        public Integer getChapId() { return ChapId; }
        public ChapterDto setChapId(Integer value) { this.ChapId = value; return this; }
        public String getCollege() { return College; }
        public ChapterDto setCollege(String value) { this.College = value; return this; }
        public String getDesignation() { return Designation; }
        public ChapterDto setDesignation(String value) { this.Designation = value; return this; }
    }

    public static class MemberType
    {
        public Integer MemTypeId = null;
        public Integer NationalId = null;
        public Integer ChapId = null;
        public String Description = null;
        public Boolean IsPrimary = null;
        
        public Integer getMemTypeId() { return MemTypeId; }
        public MemberType setMemTypeId(Integer value) { this.MemTypeId = value; return this; }
        public Integer getNationalId() { return NationalId; }
        public MemberType setNationalId(Integer value) { this.NationalId = value; return this; }
        public Integer getChapId() { return ChapId; }
        public MemberType setChapId(Integer value) { this.ChapId = value; return this; }
        public String getDescription() { return Description; }
        public MemberType setDescription(String value) { this.Description = value; return this; }
        public Boolean getIsPrimary() { return IsPrimary; }
        public MemberType setIsPrimary(Boolean value) { this.IsPrimary = value; return this; }
    }

    public static class Link
    {
        public String Rel = null;
        public String Url = null;
        
        public String getRel() { return Rel; }
        public Link setRel(String value) { this.Rel = value; return this; }
        public String getUrl() { return Url; }
        public Link setUrl(String value) { this.Url = value; return this; }
    }

}

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