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 .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.

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

<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <ChapId>0</ChapId>
  <City>String</City>
  <ClientId>0</ClientId>
  <CompanyId>0</CompanyId>
  <CompanyName>String</CompanyName>
  <Country>String</Country>
  <CountryId>0</CountryId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ExternalCompanyId>String</ExternalCompanyId>
  <Fax>String</Fax>
  <GroupId>String</GroupId>
  <PhoneNumber>String</PhoneNumber>
  <State>String</State>
  <StateId>0</StateId>
  <UniqueId>String</UniqueId>
  <Website>String</Website>
  <ZipCode>String</ZipCode>
</Company>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ErrorMessage>
  <CompanyId>0</CompanyId>
  <UniqueId>String</UniqueId>
</CompanyReply>