Billhighway Cloud API

<back to all web services

FormBuilderStateRq

The following routes are available for this service:
GET/signup/api/formBuilder/states
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.FormBuilder.Request;
using BH.CloudAPI.Common4.DTO.FormBuilder.Response;
using BH.API.DataAccess.Dto.FormBuilder;

namespace BH.API.DataAccess.Dto.FormBuilder
{
    public partial class FormBuilderState
    {
        public virtual string abbreviation { get; set; }
        public virtual int stateId { get; set; }
        public virtual string fullName { get; set; }
        public virtual int countryId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request
{
    public partial class FormBuilderStateRq
        : IApiRequest
    {
        public virtual int CountryId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response
{
    public partial class FormBuilderStateRs
    {
        public FormBuilderStateRs()
        {
            states = new List<FormBuilderState>{};
        }

        public virtual List<FormBuilderState> states { get; set; }
    }

}

C# 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>