Billhighway Cloud API

<back to all web services

Company

The following routes are available for this service:
POST/company
import Foundation
import ServiceStack

public class Company : Codable
{
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var groupId:String?
    public var companyId:Int?
    public var externalCompanyId:String?
    public var companyName:String?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var state:String?
    public var zipCode:String?
    public var country:String?
    public var website:String?
    public var phoneNumber:String?
    public var fax:String?
    public var stateId:Int?
    public var countryId:Int?
    public var chapId:Int?

    required public init(){}
}

public class CompanyReply : ReplyBase
{
    public var uniqueId:String?
    public var companyId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case uniqueId
        case companyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        uniqueId = try container.decodeIfPresent(String.self, forKey: .uniqueId)
        companyId = try container.decodeIfPresent(Int.self, forKey: .companyId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if uniqueId != nil { try container.encode(uniqueId, forKey: .uniqueId) }
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class ReplyBase : IHaveErrorField, Codable
{
    public var errorCode:Int?
    public var errorMessage:String?
    public var isError:Bool?

    required public init(){}
}


Swift 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
}