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


export class CompaniesHouseAddress
{
    public address1?: string;
    public address2?: string;
    public address3?: string;
    public city?: string;
    public postcode?: string;

    public constructor(init?: Partial<CompaniesHouseAddress>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseIncorporationDate
{
    public day?: number;
    public month?: number;
    public year?: number;

    public constructor(init?: Partial<CompaniesHouseIncorporationDate>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseShareHolderData
{
    public title?: string;
    public firstName?: string;
    public middleNames?: string;
    public lastName?: string;
    public percentageOfVotingSharesOwned?: number;

    public constructor(init?: Partial<CompaniesHouseShareHolderData>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseDirectorsData
{
    public title?: string;
    public firstName?: string;
    public middleNames?: string;
    public lastName?: string;

    public constructor(init?: Partial<CompaniesHouseDirectorsData>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseData
{
    public registeredName?: string;
    public address?: CompaniesHouseAddress;
    public dateOfIncorporation?: CompaniesHouseIncorporationDate;
    public shareHolders?: CompaniesHouseShareHolderData[];
    public directors?: CompaniesHouseDirectorsData[];

    public constructor(init?: Partial<CompaniesHouseData>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseResponse
{
    /**
    * Contains the companies house lookup result when successful.
    */
    public Result: CompaniesHouseData;
    /**
    * Contains response status, details and errors.
    */
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<CompaniesHouseResponse>) { (Object as any).assign(this, init); }
}

export class CompaniesHouseRequest
{
    /**
    * The registered company number.
    */
    // @Required()
    public CompanyNumber?: string;

    /**
    * The Csr of the application (if available).
    */
    public Csr?: string;

    public constructor(init?: Partial<CompaniesHouseRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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: wp-cddws-test.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>