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 .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}