Billhighway Cloud API

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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormInfoGetRq(IApiRequest):
    nat_i_d: Optional[int] = None
    group_id: Optional[int] = None
    user_id: Optional[str] = None
    user_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContextualHelpDto:
    control_name: Optional[str] = None
    label_text: Optional[str] = None
    is_visible: Optional[bool] = None
    is_required: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CountryDto:
    country_i_d: Optional[int] = None
    full_name: Optional[str] = None
    abbr: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StateDto:
    state_i_d: Optional[int] = None
    country_i_d: Optional[int] = None
    full_name: Optional[str] = None
    abbr: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChapterDto:
    chap_id: Optional[int] = None
    college: Optional[str] = None
    designation: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberType:
    mem_type_id: Optional[int] = None
    national_id: Optional[int] = None
    chap_id: Optional[int] = None
    description: Optional[str] = None
    is_primary: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormInfo:
    contextual_help: Optional[List[ContextualHelpDto]] = None
    countries: Optional[List[CountryDto]] = None
    states: Optional[List[StateDto]] = None
    chapters: Optional[List[ChapterDto]] = None
    member_types: Optional[List[MemberType]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Link:
    rel: Optional[str] = None
    url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormInfoGetRs(IApiResponse):
    standard_signup_form_info: Optional[StandardSignupFormInfo] = None
    links: Optional[List[Link]] = None

Python StandardSignupFormInfoGetRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

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