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
FormTemplateClientMapRq Parameters:
NameParameterData TypeRequiredDescription
NationalIDpathintNo
FormTemplateClientMapRs Parameters:
NameParameterData TypeRequiredDescription
TemplateMapsformList<FormTemplateClientMap>No
FormTemplateClientMap Parameters:
NameParameterData TypeRequiredDescription
NationalIDformintNo
ChapIDformint?No
FormTemplateIDformintNo
FormBuilderformbool?No
RelativeGroupInfoServiceApiformstringNo
RelativeGroupInfoServiceWithUserApiformstringNo
MemberInfoIntegrationPartnerApiformIntegratedPartnerNo
RequirePreAuthenticatedMemberformboolNo
IntegratedPartner Parameters:
NameParameterData TypeRequiredDescription
IntegrationPartnerIdformintNo
NameformstringNo
DescriptionformstringNo
UriformstringNo
UsernameformstringNo
PasswordformstringNo
ApiKeyformstringNo
ScopeformstringNo

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