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

namespace BH.API.CloudApi.Core
{
    public partial class Link
    {
        public virtual string Rel { get; set; }
        public virtual string Url { get; set; }
    }

}

namespace BH.API.DataAccess.Dto
{
    public partial class ChapterDto
    {
        public virtual int ChapId { get; set; }
        public virtual string College { get; set; }
        public virtual string Designation { get; set; }
    }

    public partial class ContextualHelpDto
    {
        public virtual string ControlName { get; set; }
        public virtual string LabelText { get; set; }
        public virtual bool IsVisible { get; set; }
        public virtual bool IsRequired { get; set; }
    }

    public partial class CountryDto
    {
        public virtual int CountryID { get; set; }
        public virtual string FullName { get; set; }
        public virtual string Abbr { get; set; }
    }

    public partial class MemberType
    {
        public virtual int MemTypeId { get; set; }
        public virtual int NationalId { get; set; }
        public virtual int ChapId { get; set; }
        public virtual string Description { get; set; }
        public virtual bool IsPrimary { get; set; }
    }

    public partial class StateDto
    {
        public virtual int StateID { get; set; }
        public virtual int CountryID { get; set; }
        public virtual string FullName { get; set; }
        public virtual string Abbr { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm
{
    public partial class StandardSignupFormInfo
    {
        public StandardSignupFormInfo()
        {
            ContextualHelp = new List<ContextualHelpDto>{};
            Countries = new List<CountryDto>{};
            States = new List<StateDto>{};
            Chapters = new List<ChapterDto>{};
            MemberTypes = new List<MemberType>{};
        }

        public virtual List<ContextualHelpDto> ContextualHelp { get; set; }
        public virtual List<CountryDto> Countries { get; set; }
        public virtual List<StateDto> States { get; set; }
        public virtual List<ChapterDto> Chapters { get; set; }
        public virtual List<MemberType> MemberTypes { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request
{
    public partial class StandardSignupFormInfoGetRq
        : IApiRequest
    {
        public virtual int NatID { get; set; }
        public virtual int GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string UserType { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response
{
    public partial class StandardSignupFormInfoGetRs
        : IApiResponse
    {
        public StandardSignupFormInfoGetRs()
        {
            Links = new List<Link>{};
        }

        public virtual StandardSignupFormInfo StandardSignupFormInfo { get; set; }
        public virtual List<Link> Links { get; set; }
    }

}

C# 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>