| GET, POST | /CompaniesHouse/{CompanyNumber} | ||
|---|---|---|---|
| GET, POST | /CompaniesHouse |
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CompaniesHouseRequest
{
/**
* The registered company number.
*/
@Required()
var CompanyNumber:String? = null
/**
* The Csr of the application (if available).
*/
var Csr:String? = null
}
open class CompaniesHouseResponse
{
/**
* Contains the companies house lookup result when successful.
*/
var Result:CompaniesHouseData? = null
/**
* Contains response status, details and errors.
*/
var ResponseStatus:ResponseStatus? = null
}
open class CompaniesHouseData
{
var registeredName:String? = null
var address:CompaniesHouseAddress? = null
var dateOfIncorporation:CompaniesHouseIncorporationDate? = null
var shareHolders:ArrayList<CompaniesHouseShareHolderData> = ArrayList<CompaniesHouseShareHolderData>()
var directors:ArrayList<CompaniesHouseDirectorsData> = ArrayList<CompaniesHouseDirectorsData>()
}
open class CompaniesHouseAddress
{
var address1:String? = null
var address2:String? = null
var address3:String? = null
var city:String? = null
var postcode:String? = null
}
open class CompaniesHouseIncorporationDate
{
var day:Int? = null
var month:Int? = null
var year:Int? = null
}
open class CompaniesHouseShareHolderData
{
var title:String? = null
var firstName:String? = null
var middleNames:String? = null
var lastName:String? = null
var percentageOfVotingSharesOwned:Double? = null
}
open class CompaniesHouseDirectorsData
{
var title:String? = null
var firstName:String? = null
var middleNames:String? = null
var lastName:String? = null
}
Kotlin CompaniesHouseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyNumber":"String","Csr":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}