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

export class IntegratedPartner
{
    public IntegrationPartnerId?: number;
    public Name?: string;
    public Description?: string;
    public Uri?: string;
    public Username?: string;
    public Password?: string;
    public ApiKey?: string;
    public Scope?: string;

    public constructor(init?: Partial<IntegratedPartner>) { (Object as any).assign(this, init); }
}

export class FormTemplateClientMap
{
    public NationalID?: number;
    public ChapID?: number;
    public FormTemplateID?: number;
    public FormBuilder?: boolean;
    public RelativeGroupInfoServiceApi?: string;
    public RelativeGroupInfoServiceWithUserApi?: string;
    public MemberInfoIntegrationPartnerApi?: IntegratedPartner;
    public RequirePreAuthenticatedMember?: boolean;

    public constructor(init?: Partial<FormTemplateClientMap>) { (Object as any).assign(this, init); }
}

export class FormTemplateClientMapRs implements IApiResponse
{
    public TemplateMaps?: FormTemplateClientMap[];

    public constructor(init?: Partial<FormTemplateClientMapRs>) { (Object as any).assign(this, init); }
}

export class FormTemplateClientMapRq implements IApiRequest
{
    public NationalID?: number;

    public constructor(init?: Partial<FormTemplateClientMapRq>) { (Object as any).assign(this, init); }
}

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