GET, POST | /CompaniesHouse/{CompanyNumber} | ||
---|---|---|---|
GET, POST | /CompaniesHouse |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CompaniesHouseRequest
{
/**
* The registered company number.
*/
@Required()
public String CompanyNumber = null;
/**
* The Csr of the application (if available).
*/
public String Csr = null;
public String getCompanyNumber() { return CompanyNumber; }
public CompaniesHouseRequest setCompanyNumber(String value) { this.CompanyNumber = value; return this; }
public String getCsr() { return Csr; }
public CompaniesHouseRequest setCsr(String value) { this.Csr = value; return this; }
}
public static class CompaniesHouseResponse
{
/**
* Contains the companies house lookup result when successful.
*/
public CompaniesHouseData Result = null;
/**
* Contains response status, details and errors.
*/
public ResponseStatus ResponseStatus = null;
public CompaniesHouseData getResult() { return Result; }
public CompaniesHouseResponse setResult(CompaniesHouseData value) { this.Result = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public CompaniesHouseResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class CompaniesHouseData
{
public String registeredName = null;
public CompaniesHouseAddress address = null;
public CompaniesHouseIncorporationDate dateOfIncorporation = null;
public ArrayList<CompaniesHouseShareHolderData> shareHolders = null;
public ArrayList<CompaniesHouseDirectorsData> directors = null;
public String getRegisteredName() { return registeredName; }
public CompaniesHouseData setRegisteredName(String value) { this.registeredName = value; return this; }
public CompaniesHouseAddress getAddress() { return address; }
public CompaniesHouseData setAddress(CompaniesHouseAddress value) { this.address = value; return this; }
public CompaniesHouseIncorporationDate getDateOfIncorporation() { return dateOfIncorporation; }
public CompaniesHouseData setDateOfIncorporation(CompaniesHouseIncorporationDate value) { this.dateOfIncorporation = value; return this; }
public ArrayList<CompaniesHouseShareHolderData> getShareHolders() { return shareHolders; }
public CompaniesHouseData setShareHolders(ArrayList<CompaniesHouseShareHolderData> value) { this.shareHolders = value; return this; }
public ArrayList<CompaniesHouseDirectorsData> getDirectors() { return directors; }
public CompaniesHouseData setDirectors(ArrayList<CompaniesHouseDirectorsData> value) { this.directors = value; return this; }
}
public static class CompaniesHouseAddress
{
public String address1 = null;
public String address2 = null;
public String address3 = null;
public String city = null;
public String postcode = null;
public String getAddress1() { return address1; }
public CompaniesHouseAddress setAddress1(String value) { this.address1 = value; return this; }
public String getAddress2() { return address2; }
public CompaniesHouseAddress setAddress2(String value) { this.address2 = value; return this; }
public String getAddress3() { return address3; }
public CompaniesHouseAddress setAddress3(String value) { this.address3 = value; return this; }
public String getCity() { return city; }
public CompaniesHouseAddress setCity(String value) { this.city = value; return this; }
public String getPostcode() { return postcode; }
public CompaniesHouseAddress setPostcode(String value) { this.postcode = value; return this; }
}
public static class CompaniesHouseIncorporationDate
{
public Integer day = null;
public Integer month = null;
public Integer year = null;
public Integer getDay() { return day; }
public CompaniesHouseIncorporationDate setDay(Integer value) { this.day = value; return this; }
public Integer getMonth() { return month; }
public CompaniesHouseIncorporationDate setMonth(Integer value) { this.month = value; return this; }
public Integer getYear() { return year; }
public CompaniesHouseIncorporationDate setYear(Integer value) { this.year = value; return this; }
}
public static class CompaniesHouseShareHolderData
{
public String title = null;
public String firstName = null;
public String middleNames = null;
public String lastName = null;
public Double percentageOfVotingSharesOwned = null;
public String getTitle() { return title; }
public CompaniesHouseShareHolderData setTitle(String value) { this.title = value; return this; }
public String getFirstName() { return firstName; }
public CompaniesHouseShareHolderData setFirstName(String value) { this.firstName = value; return this; }
public String getMiddleNames() { return middleNames; }
public CompaniesHouseShareHolderData setMiddleNames(String value) { this.middleNames = value; return this; }
public String getLastName() { return lastName; }
public CompaniesHouseShareHolderData setLastName(String value) { this.lastName = value; return this; }
public Double getPercentageOfVotingSharesOwned() { return percentageOfVotingSharesOwned; }
public CompaniesHouseShareHolderData setPercentageOfVotingSharesOwned(Double value) { this.percentageOfVotingSharesOwned = value; return this; }
}
public static class CompaniesHouseDirectorsData
{
public String title = null;
public String firstName = null;
public String middleNames = null;
public String lastName = null;
public String getTitle() { return title; }
public CompaniesHouseDirectorsData setTitle(String value) { this.title = value; return this; }
public String getFirstName() { return firstName; }
public CompaniesHouseDirectorsData setFirstName(String value) { this.firstName = value; return this; }
public String getMiddleNames() { return middleNames; }
public CompaniesHouseDirectorsData setMiddleNames(String value) { this.middleNames = value; return this; }
public String getLastName() { return lastName; }
public CompaniesHouseDirectorsData setLastName(String value) { this.lastName = value; return this; }
}
}
Java CompaniesHouseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>