Billhighway Cloud API

FormBuilderPlanTypeRq

The following routes are available for this service:
GET	/signup/api/forms/templates/nat/{nationalID}/chap/{chapID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType

import Foundation
import ServiceStack

public class FormBuilderPlanTypeRq : IApiRequest, Codable
{
    public var nationalID:Int?
    public var chapID:Int?
    public var formBuilderPlanTypeID:Int?

    required public init(){}
}

public class FormBuilderPlanTypeRs : IApiResponse, Codable
{
    public var formBuilderPlanTypes:[FormBuilderPlanType] = []

    required public init(){}
}

public class FormBuilderPlanType : Codable
{
    public var nationalID:Int?
    public var chapID:Int?
    public var formBuilderPlanTypeID:Int?
    public var themeID:Int?
    public var relativeGroupInfoServiceApi:String?
    public var relativeGroupInfoServiceWithUserApi:String?

    required public init(){}
}

Swift FormBuilderPlanTypeRq 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}/chap/{chapID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

<FormBuilderPlanTypeRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Client.Configuration.Service">
  <FormBuilderPlanTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Client.Configuration">
    <d2p1:FormBuilderPlanType>
      <d2p1:_x003C_ChapID_x003E_k__BackingField>0</d2p1:_x003C_ChapID_x003E_k__BackingField>
      <d2p1:_x003C_FormBuilderPlanTypeID_x003E_k__BackingField>0</d2p1:_x003C_FormBuilderPlanTypeID_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_ThemeID_x003E_k__BackingField>0</d2p1:_x003C_ThemeID_x003E_k__BackingField>
    </d2p1:FormBuilderPlanType>
  </FormBuilderPlanTypes>
</FormBuilderPlanTypeRs>