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 Foundation
import ServiceStack

public class StandardSignupFormInfoGetRq : IApiRequest, Codable
{
    public var natID:Int?
    public var groupId:Int?
    public var userId:String?
    public var userType:String?

    required public init(){}
}

public class StandardSignupFormInfoGetRs : IApiResponse, Codable
{
    public var standardSignupFormInfo:StandardSignupFormInfo?
    public var links:[Link] = []

    required public init(){}
}

public class StandardSignupFormInfo : Codable
{
    public var contextualHelp:[ContextualHelpDto] = []
    public var countries:[CountryDto] = []
    public var states:[StateDto] = []
    public var chapters:[ChapterDto] = []
    public var memberTypes:[MemberType] = []

    required public init(){}
}

public class ContextualHelpDto : Codable
{
    public var controlName:String?
    public var labelText:String?
    public var isVisible:Bool?
    public var isRequired:Bool?

    required public init(){}
}

public class CountryDto : Codable
{
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class StateDto : Codable
{
    public var stateID:Int?
    public var countryID:Int?
    public var fullName:String?
    public var abbr:String?

    required public init(){}
}

public class ChapterDto : Codable
{
    public var chapId:Int?
    public var college:String?
    public var designation:String?

    required public init(){}
}

public class MemberType : Codable
{
    public var memTypeId:Int?
    public var nationalId:Int?
    public var chapId:Int?
    public var Description:String?
    public var isPrimary:Bool?

    required public init(){}
}

public class Link : Codable
{
    public var rel:String?
    public var url:String?

    required public init(){}
}


Swift 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>