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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.StandardSignupForm.Request
Imports BH.CloudAPI.Common4.DTO.StandardSignupForm.Response
Imports BH.CloudAPI.Common4.DTO.StandardSignupForm
Imports BH.API.DataAccess.Dto
Imports BH.API.CloudApi.Core

Namespace Global

    Namespace BH.API.CloudApi.Core

        Public Partial Class Link
            Public Overridable Property Rel As String
            Public Overridable Property Url As String
        End Class
    End Namespace

    Namespace BH.API.DataAccess.Dto

        Public Partial Class ChapterDto
            Public Overridable Property ChapId As Integer
            Public Overridable Property College As String
            Public Overridable Property Designation As String
        End Class

        Public Partial Class ContextualHelpDto
            Public Overridable Property ControlName As String
            Public Overridable Property LabelText As String
            Public Overridable Property IsVisible As Boolean
            Public Overridable Property IsRequired As Boolean
        End Class

        Public Partial Class CountryDto
            Public Overridable Property CountryID As Integer
            Public Overridable Property FullName As String
            Public Overridable Property Abbr As String
        End Class

        Public Partial Class MemberType
            Public Overridable Property MemTypeId As Integer
            Public Overridable Property NationalId As Integer
            Public Overridable Property ChapId As Integer
            Public Overridable Property Description As String
            Public Overridable Property IsPrimary As Boolean
        End Class

        Public Partial Class StateDto
            Public Overridable Property StateID As Integer
            Public Overridable Property CountryID As Integer
            Public Overridable Property FullName As String
            Public Overridable Property Abbr As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm

        Public Partial Class StandardSignupFormInfo
            Public Sub New()
                ContextualHelp = New List(Of ContextualHelpDto)
                Countries = New List(Of CountryDto)
                States = New List(Of StateDto)
                Chapters = New List(Of ChapterDto)
                MemberTypes = New List(Of MemberType)
            End Sub

            Public Overridable Property ContextualHelp As List(Of ContextualHelpDto)
            Public Overridable Property Countries As List(Of CountryDto)
            Public Overridable Property States As List(Of StateDto)
            Public Overridable Property Chapters As List(Of ChapterDto)
            Public Overridable Property MemberTypes As List(Of MemberType)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request

        Public Partial Class StandardSignupFormInfoGetRq
            Implements IApiRequest
            Public Overridable Property NatID As Integer
            Public Overridable Property GroupId As Integer
            Public Overridable Property UserId As String
            Public Overridable Property UserType As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response

        Public Partial Class StandardSignupFormInfoGetRs
            Implements IApiResponse
            Public Sub New()
                Links = New List(Of Link)
            End Sub

            Public Overridable Property StandardSignupFormInfo As StandardSignupFormInfo
            Public Overridable Property Links As List(Of Link)
        End Class
    End Namespace
End Namespace

VB.NET StandardSignupFormInfoGetRq DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StandardSignupFormInfoGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Response">
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
    <d2p1:Link>
      <d2p1:Rel>String</d2p1:Rel>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:Link>
  </Links>
  <StandardSignupFormInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm">
    <d2p1:_x003C_Chapters_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
      <d3p1:ChapterDto>
        <d3p1:ChapId>0</d3p1:ChapId>
        <d3p1:College>String</d3p1:College>
        <d3p1:Designation>String</d3p1:Designation>
      </d3p1:ChapterDto>
    </d2p1:_x003C_Chapters_x003E_k__BackingField>
    <d2p1:_x003C_ContextualHelp_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
      <d3p1:ContextualHelpDto>
        <d3p1:ControlName>String</d3p1:ControlName>
        <d3p1:IsRequired>false</d3p1:IsRequired>
        <d3p1:IsVisible>false</d3p1:IsVisible>
        <d3p1:LabelText>String</d3p1:LabelText>
      </d3p1:ContextualHelpDto>
    </d2p1:_x003C_ContextualHelp_x003E_k__BackingField>
    <d2p1:_x003C_Countries_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
      <d3p1:CountryDto>
        <d3p1:Abbr>String</d3p1:Abbr>
        <d3p1:CountryID>0</d3p1:CountryID>
        <d3p1:FullName>String</d3p1:FullName>
      </d3p1:CountryDto>
    </d2p1:_x003C_Countries_x003E_k__BackingField>
    <d2p1:_x003C_MemberTypes_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
      <d3p1:MemberType>
        <d3p1:ChapId>0</d3p1:ChapId>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:IsPrimary>false</d3p1:IsPrimary>
        <d3p1:MemTypeId>0</d3p1:MemTypeId>
        <d3p1:NationalId>0</d3p1:NationalId>
      </d3p1:MemberType>
    </d2p1:_x003C_MemberTypes_x003E_k__BackingField>
    <d2p1:_x003C_States_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
      <d3p1:StateDto>
        <d3p1:Abbr>String</d3p1:Abbr>
        <d3p1:CountryID>0</d3p1:CountryID>
        <d3p1:FullName>String</d3p1:FullName>
        <d3p1:StateID>0</d3p1:StateID>
      </d3p1:StateDto>
    </d2p1:_x003C_States_x003E_k__BackingField>
  </StandardSignupFormInfo>
</StandardSignupFormInfoGetRs>