CDD Engine Web Service v2.14.0.0

<back to all web services

CompaniesHouseRequest

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CDD_Engine_WS.dto.Requests;
using CDD_Engine_WS.dto.Responses;
using CDD_Engine_DLL.DataObjects;

namespace CDD_Engine_DLL.DataObjects
{
    public partial class CompaniesHouseAddress
    {
        public virtual string address1 { get; set; }
        public virtual string address2 { get; set; }
        public virtual string address3 { get; set; }
        public virtual string city { get; set; }
        public virtual string postcode { get; set; }
    }

    public partial class CompaniesHouseData
    {
        public CompaniesHouseData()
        {
            shareHolders = new List<CompaniesHouseShareHolderData>{};
            directors = new List<CompaniesHouseDirectorsData>{};
        }

        public virtual string registeredName { get; set; }
        public virtual CompaniesHouseAddress address { get; set; }
        public virtual CompaniesHouseIncorporationDate dateOfIncorporation { get; set; }
        public virtual List<CompaniesHouseShareHolderData> shareHolders { get; set; }
        public virtual List<CompaniesHouseDirectorsData> directors { get; set; }
    }

    public partial class CompaniesHouseDirectorsData
    {
        public virtual string title { get; set; }
        public virtual string firstName { get; set; }
        public virtual string middleNames { get; set; }
        public virtual string lastName { get; set; }
    }

    public partial class CompaniesHouseIncorporationDate
    {
        public virtual int day { get; set; }
        public virtual int month { get; set; }
        public virtual int year { get; set; }
    }

    public partial class CompaniesHouseShareHolderData
    {
        public virtual string title { get; set; }
        public virtual string firstName { get; set; }
        public virtual string middleNames { get; set; }
        public virtual string lastName { get; set; }
        public virtual double? percentageOfVotingSharesOwned { get; set; }
    }

}

namespace CDD_Engine_WS.dto.Requests
{
    public partial class CompaniesHouseRequest
    {
        ///<summary>
        ///The registered company number.
        ///</summary>
        [Required]
        public virtual string CompanyNumber { get; set; }

        ///<summary>
        ///The Csr of the application (if available).
        ///</summary>
        public virtual string Csr { get; set; }
    }

}

namespace CDD_Engine_WS.dto.Responses
{
    public partial class CompaniesHouseResponse
    {
        ///<summary>
        ///Contains the companies house lookup result when successful.
        ///</summary>
        public virtual CompaniesHouseData Result { get; set; }
        ///<summary>
        ///Contains response status, details and errors.
        ///</summary>
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CompaniesHouseRequest DTOs

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>