Billhighway Cloud API

FormBuilderStateRq

The following routes are available for this service:
GET	/signup/api/formBuilder/states

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderStateRq(IApiRequest):
    country_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderState:
    abbreviation: Optional[str] = None
    state_id: Optional[int] = None
    full_name: Optional[str] = None
    country_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderStateRs:
    states: Optional[List[FormBuilderState]] = None

Python FormBuilderStateRq 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/formBuilder/states HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

<FormBuilderStateRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <states xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto.FormBuilder">
    <d2p1:FormBuilderState>
      <d2p1:abbreviation>String</d2p1:abbreviation>
      <d2p1:countryId>0</d2p1:countryId>
      <d2p1:fullName>String</d2p1:fullName>
      <d2p1:stateId>0</d2p1:stateId>
    </d2p1:FormBuilderState>
  </states>
</FormBuilderStateRs>