Billhighway Cloud API

<back to all web services

Company

The following routes are available for this service:
POST/company
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Company() = 
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val CompanyId:Int32 = new Int32() with get,set
        member val ExternalCompanyId:String = null with get,set
        member val CompanyName:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val ZipCode:String = null with get,set
        member val Country:String = null with get,set
        member val Website:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val Fax:String = null with get,set
        member val StateId:Int32 = new Int32() with get,set
        member val CountryId:Int32 = new Int32() with get,set
        member val ChapId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ReplyBase() = 
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CompanyReply() = 
        inherit ReplyBase()
        member val UniqueId:String = null with get,set
        member val CompanyId:Int32 = new Int32() with get,set

F# Company DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /company HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	GroupId: String,
	CompanyId: 0,
	ExternalCompanyId: String,
	CompanyName: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	ZipCode: String,
	Country: String,
	Website: String,
	PhoneNumber: String,
	Fax: String,
	StateId: 0,
	CountryId: 0,
	ChapId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CompanyId: 0,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False
}