CDD Engine Web Service v2.14.0.0

CompaniesHouseRequest

iNASA

The following routes are available for this service:
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

F# CompaniesHouseRequest 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 /CompaniesHouse/{CompanyNumber} HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompaniesHouseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
  <CompanyNumber>String</CompanyNumber>
  <Csr>String</Csr>
</CompaniesHouseRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesHouseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/CDD_Engine_DLL.DataObjects">
    <d2p1:address>
      <d2p1:address1>String</d2p1:address1>
      <d2p1:address2>String</d2p1:address2>
      <d2p1:address3>String</d2p1:address3>
      <d2p1:city>String</d2p1:city>
      <d2p1:postcode>String</d2p1:postcode>
    </d2p1:address>
    <d2p1:dateOfIncorporation>
      <d2p1:day>0</d2p1:day>
      <d2p1:month>0</d2p1:month>
      <d2p1:year>0</d2p1:year>
    </d2p1:dateOfIncorporation>
    <d2p1:directors>
      <d2p1:CompaniesHouseDirectorsData>
        <d2p1:firstName>String</d2p1:firstName>
        <d2p1:lastName>String</d2p1:lastName>
        <d2p1:middleNames>String</d2p1:middleNames>
        <d2p1:title>String</d2p1:title>
      </d2p1:CompaniesHouseDirectorsData>
    </d2p1:directors>
    <d2p1:registeredName>String</d2p1:registeredName>
    <d2p1:shareHolders>
      <d2p1:CompaniesHouseShareHolderData>
        <d2p1:firstName>String</d2p1:firstName>
        <d2p1:lastName>String</d2p1:lastName>
        <d2p1:middleNames>String</d2p1:middleNames>
        <d2p1:percentageOfVotingSharesOwned>0</d2p1:percentageOfVotingSharesOwned>
        <d2p1:title>String</d2p1:title>
      </d2p1:CompaniesHouseShareHolderData>
    </d2p1:shareHolders>
  </Result>
</CompaniesHouseResponse>