| GET | /signup/api/forms/templates/nat/{nationalID}/clientmap |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NationalID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TemplateMaps | form | List<FormTemplateClientMap> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NationalID | form | int | No | |
| ChapID | form | int? | No | |
| FormTemplateID | form | int | No | |
| FormBuilder | form | bool? | No | |
| RelativeGroupInfoServiceApi | form | string | No | |
| RelativeGroupInfoServiceWithUserApi | form | string | No | |
| MemberInfoIntegrationPartnerApi | form | IntegratedPartner | No | |
| RequirePreAuthenticatedMember | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IntegrationPartnerId | form | int | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Uri | form | string | No | |
| Username | form | string | No | |
| Password | form | string | No | |
| ApiKey | form | string | No | |
| Scope | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}