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

public class FormTemplateClientMapRq : IApiRequest, Codable
{
    public var nationalID:Int?

    required public init(){}
}

public class FormTemplateClientMapRs : IApiResponse, Codable
{
    public var templateMaps:[FormTemplateClientMap] = []

    required public init(){}
}

public class FormTemplateClientMap : Codable
{
    public var nationalID:Int?
    public var chapID:Int?
    public var formTemplateID:Int?
    public var formBuilder:Bool?
    public var relativeGroupInfoServiceApi:String?
    public var relativeGroupInfoServiceWithUserApi:String?
    public var memberInfoIntegrationPartnerApi:IntegratedPartner?
    public var requirePreAuthenticatedMember:Bool?

    required public init(){}
}

public class IntegratedPartner : Codable
{
    public var integrationPartnerId:Int?
    public var name:String?
    public var Description:String?
    public var uri:String?
    public var username:String?
    public var password:String?
    public var apiKey:String?
    public var scope:String?

    required public init(){}
}


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