Billhighway Cloud API

<back to all web services

FormTemplateClientMapRq

The following routes are available for this service:
GET/signup/api/forms/templates/nat/{nationalID}/clientmap
namespace BH.Client.Configuration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type IntegratedPartner() = 
        member val IntegrationPartnerId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Uri:String = null with get,set
        member val Username:String = null with get,set
        member val Password:String = null with get,set
        member val ApiKey:String = null with get,set
        member val Scope:String = null with get,set

    [<AllowNullLiteral>]
    type FormTemplateClientMap() = 
        member val NationalID:Int32 = new Int32() with get,set
        member val ChapID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FormTemplateID:Int32 = new Int32() with get,set
        member val FormBuilder:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val RelativeGroupInfoServiceApi:String = null with get,set
        member val RelativeGroupInfoServiceWithUserApi:String = null with get,set
        member val MemberInfoIntegrationPartnerApi:IntegratedPartner = null with get,set
        member val RequirePreAuthenticatedMember:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FormTemplateClientMapRs() = 
        member val TemplateMaps:ResizeArray<FormTemplateClientMap> = new ResizeArray<FormTemplateClientMap>() with get,set

    [<AllowNullLiteral>]
    type FormTemplateClientMapRq() = 
        member val NationalID:Int32 = new Int32() with get,set

F# FormTemplateClientMapRq 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/forms/templates/nat/{nationalID}/clientmap HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TemplateMaps: 
	[
		{
			NationalID: 0,
			ChapID: 0,
			FormTemplateID: 0,
			FormBuilder: False,
			RelativeGroupInfoServiceApi: String,
			RelativeGroupInfoServiceWithUserApi: String,
			MemberInfoIntegrationPartnerApi: 
			{
				IntegrationPartnerId: 0,
				Name: String,
				Description: String,
				Uri: String,
				Username: String,
				Password: String,
				ApiKey: String,
				Scope: String
			},
			RequirePreAuthenticatedMember: False
		}
	]
}