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

export class StandardSignupFormInfoGetRq implements IApiRequest
{
    public NatID?: number;
    public GroupId?: number;
    public UserId?: string;
    public UserType?: string;

    public constructor(init?: Partial<StandardSignupFormInfoGetRq>) { (Object as any).assign(this, init); }
}

export class ContextualHelpDto
{
    public ControlName?: string;
    public LabelText?: string;
    public IsVisible?: boolean;
    public IsRequired?: boolean;

    public constructor(init?: Partial<ContextualHelpDto>) { (Object as any).assign(this, init); }
}

export class CountryDto
{
    public CountryID?: number;
    public FullName?: string;
    public Abbr?: string;

    public constructor(init?: Partial<CountryDto>) { (Object as any).assign(this, init); }
}

export class StateDto
{
    public StateID?: number;
    public CountryID?: number;
    public FullName?: string;
    public Abbr?: string;

    public constructor(init?: Partial<StateDto>) { (Object as any).assign(this, init); }
}

export class ChapterDto
{
    public ChapId?: number;
    public College?: string;
    public Designation?: string;

    public constructor(init?: Partial<ChapterDto>) { (Object as any).assign(this, init); }
}

export class MemberType
{
    public MemTypeId?: number;
    public NationalId?: number;
    public ChapId?: number;
    public Description?: string;
    public IsPrimary?: boolean;

    public constructor(init?: Partial<MemberType>) { (Object as any).assign(this, init); }
}

export class StandardSignupFormInfo
{
    public ContextualHelp?: ContextualHelpDto[];
    public Countries?: CountryDto[];
    public States?: StateDto[];
    public Chapters?: ChapterDto[];
    public MemberTypes?: MemberType[];

    public constructor(init?: Partial<StandardSignupFormInfo>) { (Object as any).assign(this, init); }
}

export class Link
{
    public Rel?: string;
    public Url?: string;

    public constructor(init?: Partial<Link>) { (Object as any).assign(this, init); }
}

export class StandardSignupFormInfoGetRs implements IApiResponse
{
    public StandardSignupFormInfo?: StandardSignupFormInfo;
    public Links?: Link[];

    public constructor(init?: Partial<StandardSignupFormInfoGetRs>) { (Object as any).assign(this, init); }
}

TypeScript StandardSignupFormInfoGetRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}