| GET | /signup/api/nat/{natID}/standardSignup/info | ||
|---|---|---|---|
| GET | /signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/standardSignup/info |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NatID | path | int | No | |
| GroupId | path | int | No | |
| UserId | path | string | No | |
| UserType | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StandardSignupFormInfo | form | StandardSignupFormInfo | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContextualHelp | form | List<ContextualHelpDto> | No | |
| Countries | form | List<CountryDto> | No | |
| States | form | List<StateDto> | No | |
| Chapters | form | List<ChapterDto> | No | |
| MemberTypes | form | List<MemberType> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ControlName | form | string | No | |
| LabelText | form | string | No | |
| IsVisible | form | bool | No | |
| IsRequired | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CountryID | form | int | No | |
| FullName | form | string | No | |
| Abbr | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StateID | form | int | No | |
| CountryID | form | int | No | |
| FullName | form | string | No | |
| Abbr | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ChapId | form | int | No | |
| College | form | string | No | |
| Designation | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemTypeId | form | int | No | |
| NationalId | form | int | No | |
| ChapId | form | int | No | |
| Description | form | string | No | |
| IsPrimary | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Rel | form | string | No | |
| Url | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}