| GET, POST | /CompaniesHouse/{CompanyNumber} | ||
|---|---|---|---|
| GET, POST | /CompaniesHouse |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CDD_Engine_WS.dto.Requests
Imports CDD_Engine_WS.dto.Responses
Imports CDD_Engine_DLL.DataObjects
Namespace Global
Namespace CDD_Engine_DLL.DataObjects
Public Partial Class CompaniesHouseAddress
Public Overridable Property address1 As String
Public Overridable Property address2 As String
Public Overridable Property address3 As String
Public Overridable Property city As String
Public Overridable Property postcode As String
End Class
Public Partial Class CompaniesHouseData
Public Sub New()
shareHolders = New List(Of CompaniesHouseShareHolderData)
directors = New List(Of CompaniesHouseDirectorsData)
End Sub
Public Overridable Property registeredName As String
Public Overridable Property address As CompaniesHouseAddress
Public Overridable Property dateOfIncorporation As CompaniesHouseIncorporationDate
Public Overridable Property shareHolders As List(Of CompaniesHouseShareHolderData)
Public Overridable Property directors As List(Of CompaniesHouseDirectorsData)
End Class
Public Partial Class CompaniesHouseDirectorsData
Public Overridable Property title As String
Public Overridable Property firstName As String
Public Overridable Property middleNames As String
Public Overridable Property lastName As String
End Class
Public Partial Class CompaniesHouseIncorporationDate
Public Overridable Property day As Integer
Public Overridable Property month As Integer
Public Overridable Property year As Integer
End Class
Public Partial Class CompaniesHouseShareHolderData
Public Overridable Property title As String
Public Overridable Property firstName As String
Public Overridable Property middleNames As String
Public Overridable Property lastName As String
Public Overridable Property percentageOfVotingSharesOwned As Nullable(Of Double)
End Class
End Namespace
Namespace CDD_Engine_WS.dto.Requests
Public Partial Class CompaniesHouseRequest
'''<Summary>
'''The registered company number.
'''</Summary>
<Required>
Public Overridable Property CompanyNumber As String
'''<Summary>
'''The Csr of the application (if available).
'''</Summary>
Public Overridable Property Csr As String
End Class
End Namespace
Namespace CDD_Engine_WS.dto.Responses
Public Partial Class CompaniesHouseResponse
'''<Summary>
'''Contains the companies house lookup result when successful.
'''</Summary>
Public Overridable Property Result As CompaniesHouseData
'''<Summary>
'''Contains response status, details and errors.
'''</Summary>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET CompaniesHouseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"CompanyNumber":"String","Csr":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}