| GET, POST | /CompaniesHouse/{CompanyNumber} | ||
|---|---|---|---|
| GET, POST | /CompaniesHouse |
import Foundation
import ServiceStack
public class CompaniesHouseRequest : Codable
{
/**
* The registered company number.
*/
// @Required()
public var companyNumber:String?
/**
* The Csr of the application (if available).
*/
public var csr:String?
required public init(){}
}
public class CompaniesHouseResponse : Codable
{
/**
* Contains the companies house lookup result when successful.
*/
public var result:CompaniesHouseData?
/**
* Contains response status, details and errors.
*/
public var responseStatus:ResponseStatus?
required public init(){}
}
public class CompaniesHouseData : Codable
{
public var registeredName:String?
public var address:CompaniesHouseAddress?
public var dateOfIncorporation:CompaniesHouseIncorporationDate?
public var shareHolders:[CompaniesHouseShareHolderData] = []
public var directors:[CompaniesHouseDirectorsData] = []
required public init(){}
}
public class CompaniesHouseAddress : Codable
{
public var address1:String?
public var address2:String?
public var address3:String?
public var city:String?
public var postcode:String?
required public init(){}
}
public class CompaniesHouseIncorporationDate : Codable
{
public var day:Int?
public var month:Int?
public var year:Int?
required public init(){}
}
public class CompaniesHouseShareHolderData : Codable
{
public var title:String?
public var firstName:String?
public var middleNames:String?
public var lastName:String?
public var percentageOfVotingSharesOwned:Double?
required public init(){}
}
public class CompaniesHouseDirectorsData : Codable
{
public var title:String?
public var firstName:String?
public var middleNames:String?
public var lastName:String?
required public init(){}
}
Swift CompaniesHouseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CompaniesHouse/{CompanyNumber} HTTP/1.1
Host: wpcdd-featuretest-ws.worldpay.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyNumber":"String","Csr":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Result":{"registeredName":"String","address":{"address1":"String","address2":"String","address3":"String","city":"String","postcode":"String"},"dateOfIncorporation":{"day":0,"month":0,"year":0},"shareHolders":[{"title":"String","firstName":"String","middleNames":"String","lastName":"String","percentageOfVotingSharesOwned":0}],"directors":[{"title":"String","firstName":"String","middleNames":"String","lastName":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}