GET, POST | /CompaniesHouse/{CompanyNumber} | ||
---|---|---|---|
GET, POST | /CompaniesHouse |
namespace CDD_Engine_DLL.DataObjects
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CompaniesHouseAddress() =
member val address1:String = null with get,set
member val address2:String = null with get,set
member val address3:String = null with get,set
member val city:String = null with get,set
member val postcode:String = null with get,set
[<AllowNullLiteral>]
type CompaniesHouseIncorporationDate() =
member val day:Int32 = new Int32() with get,set
member val month:Int32 = new Int32() with get,set
member val year:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CompaniesHouseShareHolderData() =
member val title:String = null with get,set
member val firstName:String = null with get,set
member val middleNames:String = null with get,set
member val lastName:String = null with get,set
member val percentageOfVotingSharesOwned:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type CompaniesHouseDirectorsData() =
member val title:String = null with get,set
member val firstName:String = null with get,set
member val middleNames:String = null with get,set
member val lastName:String = null with get,set
[<AllowNullLiteral>]
type CompaniesHouseData() =
member val registeredName:String = null with get,set
member val address:CompaniesHouseAddress = null with get,set
member val dateOfIncorporation:CompaniesHouseIncorporationDate = null with get,set
member val shareHolders:ResizeArray<CompaniesHouseShareHolderData> = new ResizeArray<CompaniesHouseShareHolderData>() with get,set
member val directors:ResizeArray<CompaniesHouseDirectorsData> = new ResizeArray<CompaniesHouseDirectorsData>() with get,set
[<AllowNullLiteral>]
type CompaniesHouseResponse() =
///<summary>
///Contains the companies house lookup result when successful.
///</summary>
member val Result:CompaniesHouseData = null with get,set
///<summary>
///Contains response status, details and errors.
///</summary>
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type CompaniesHouseRequest() =
///<summary>
///The registered company number.
///</summary>
[<Required>]
member val CompanyNumber:String = null with get,set
///<summary>
///The Csr of the application (if available).
///</summary>
member val Csr:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: wp-cddws-test.worldpay.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyNumber: String,
Csr: String
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 } } }