Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Request
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Response

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request

        Public Partial Class FormBuilderModelNameValue
            Public Overridable Property Name As String
            Public Overridable Property Value As Object
        End Class

        Public Partial Class FormBuilderModelRq
            Public Sub New()
                NameValues = New List(Of FormBuilderModelNameValue)
            End Sub

            Public Overridable Property TemplateId As Integer
            Public Overridable Property BhUserID As String
            Public Overridable Property UserType As String
            Public Overridable Property ClientDocNo As String
            Public Overridable Property FormType As String
            Public Overridable Property ConfirmationNumber As Integer
            Public Overridable Property NameValues As List(Of FormBuilderModelNameValue)
            Public Overridable Property GroupPlans As String
            Public Overridable Property natId As Integer
            Public Overridable Property chapId As Integer
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response

        Public Partial Class FormBuilderModelRs
            Public Overridable Property message As String
            Public Overridable Property modelStateId As Integer
        End Class
    End Namespace
End Namespace

VB.NET FormBuilderModelRq 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.

POST /signup/api/formbuilder/model HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormBuilderModelRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Request">
  <BhUserID>String</BhUserID>
  <ClientDocNo>String</ClientDocNo>
  <ConfirmationNumber>0</ConfirmationNumber>
  <FormType>String</FormType>
  <GroupPlans>String</GroupPlans>
  <NameValues>
    <FormBuilderModelNameValue>
      <Name>String</Name>
      <Value />
    </FormBuilderModelNameValue>
  </NameValues>
  <TemplateId>0</TemplateId>
  <UserType>String</UserType>
  <chapId>0</chapId>
  <natId>0</natId>
</FormBuilderModelRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderModelRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <message>String</message>
  <modelStateId>0</modelStateId>
</FormBuilderModelRs>