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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.Client.Configuration.Service
Imports BH.Client.Configuration

Namespace Global

    Namespace BH.Client.Configuration

        Public Partial Class FormTemplateClientMap
            Public Overridable Property NationalID As Integer
            Public Overridable Property ChapID As Nullable(Of Integer)
            Public Overridable Property FormTemplateID As Integer
            Public Overridable Property FormBuilder As Nullable(Of Boolean)
            Public Overridable Property RelativeGroupInfoServiceApi As String
            Public Overridable Property RelativeGroupInfoServiceWithUserApi As String
            Public Overridable Property MemberInfoIntegrationPartnerApi As IntegratedPartner
            Public Overridable Property RequirePreAuthenticatedMember As Boolean
        End Class

        Public Partial Class IntegratedPartner
            Public Overridable Property IntegrationPartnerId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Uri As String
            Public Overridable Property Username As String
            Public Overridable Property Password As String
            Public Overridable Property ApiKey As String
            Public Overridable Property Scope As String
        End Class
    End Namespace

    Namespace BH.Client.Configuration.Service

        Public Partial Class FormTemplateClientMapRq
            Implements IApiRequest
            Public Overridable Property NationalID As Integer
        End Class

        Public Partial Class FormTemplateClientMapRs
            Implements IApiResponse
            Public Sub New()
                TemplateMaps = New List(Of FormTemplateClientMap)
            End Sub

            Public Overridable Property TemplateMaps As List(Of FormTemplateClientMap)
        End Class
    End Namespace
End Namespace

VB.NET FormTemplateClientMapRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormTemplateClientMapRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Client.Configuration.Service">
  <TemplateMaps xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Client.Configuration">
    <d2p1:FormTemplateClientMap>
      <d2p1:_x003C_ChapID_x003E_k__BackingField>0</d2p1:_x003C_ChapID_x003E_k__BackingField>
      <d2p1:_x003C_FormBuilder_x003E_k__BackingField>false</d2p1:_x003C_FormBuilder_x003E_k__BackingField>
      <d2p1:_x003C_FormTemplateID_x003E_k__BackingField>0</d2p1:_x003C_FormTemplateID_x003E_k__BackingField>
      <d2p1:_x003C_MemberInfoIntegrationPartnerApi_x003E_k__BackingField>
        <d2p1:_x003C_ApiKey_x003E_k__BackingField>String</d2p1:_x003C_ApiKey_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>0</d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
        <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
        <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
        <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
      </d2p1:_x003C_MemberInfoIntegrationPartnerApi_x003E_k__BackingField>
      <d2p1:_x003C_NationalID_x003E_k__BackingField>0</d2p1:_x003C_NationalID_x003E_k__BackingField>
      <d2p1:_x003C_RelativeGroupInfoServiceApi_x003E_k__BackingField>String</d2p1:_x003C_RelativeGroupInfoServiceApi_x003E_k__BackingField>
      <d2p1:_x003C_RelativeGroupInfoServiceWithUserApi_x003E_k__BackingField>String</d2p1:_x003C_RelativeGroupInfoServiceWithUserApi_x003E_k__BackingField>
      <d2p1:_x003C_RequirePreAuthenticatedMember_x003E_k__BackingField>false</d2p1:_x003C_RequirePreAuthenticatedMember_x003E_k__BackingField>
    </d2p1:FormTemplateClientMap>
  </TemplateMaps>
</FormTemplateClientMapRs>