Sanctions Search API: v2

<back to all web services

AddCompanyLookup

CompanyLookup
The following routes are available for this service:
POST/companylookups/createCreate a company lookup
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.CompanyLookup
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types

Namespace Global

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

        Public Partial Class ArrayOfResponseError
            Inherits List(Of ResponseError)
        End Class

        <DataContract>
        Public Partial Class BaseRequest
            Implements IBaseRequest
            '''<Summary>
            '''The authentication credentials
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property Authentication As Authentication
        End Class

        Public Partial Class BaseResponse
            Implements IBaseDataResponse
            Implements IHasResponseStatus
            '''<Summary>
            '''The status of the response
            '''</Summary>
            <ApiMember(Description:="The status of the response")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class ResponseError
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=3)>
            Public Overridable Property Message As String

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class ResponseStatus
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property Message As String

            <DataMember(Order:=3)>
            Public Overridable Property StackTrace As String

            <DataMember(Order:=4)>
            Public Overridable Property Errors As ArrayOfResponseError

            <DataMember(Order:=5)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.CompanyLookup

        <DataContract>
        Public Partial Class AddCompanyLookup
            Inherits BaseRequest
            <DataMember>
            Public Overridable Property Request As AddCompanyLookupRequest
        End Class

        Public Partial Class AddCompanyLookupData
            Inherits BaseResponse
            Implements IBaseSearchResponse
            Public Overridable Property LinkedTo As ArrayOfLinkedTo
            Public Overridable Property SearchRecord As CompanyLookupSearchRecord
        End Class

        Public Partial Class AddCompanyLookupRequest
            '''<Summary>
            '''If the search should be saved against a single Sub User account, specify their username here
            '''</Summary>
            <ApiMember(Description:="If the search should be saved against a single Sub User account, specify their username here")>
            Public Overridable Property SubUserName As String

            Public Overridable Property CompanyLookupId As Nullable(Of Integer)
            Public Overridable Property CompanyRegistrationNumber As String
            Public Overridable Property CompanyName As String
            Public Overridable Property CompanyAddress As String
            Public Overridable Property CompanyCountry As String
            Public Overridable Property PerformEnhancedSearch As Boolean
            Public Overridable Property SelectedLists As ArrayOfLists
            '''<Summary>
            '''If the search should be linked to other searches, specify the them here
            '''</Summary>
            <ApiMember(Description:="If the search should be linked to other searches, specify the them here")>
            Public Overridable Property LinkedTo As ArrayOfLinkedTo
        End Class

        <DataContract>
        Public Partial Class AddCompanyLookupResponse
            <DataMember>
            Public Overridable Property Data As AddCompanyLookupData
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Types

        Public Partial Class ArrayOfLinkedTo
            Inherits List(Of LinkedTo)
        End Class

        Public Partial Class ArrayOfLists
            Inherits List(Of String)
        End Class

        <DataContract>
        Public Partial Class Authentication
            '''<Summary>
            '''The API User ID provided by us when you signed up to use our API
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The API User ID provided by us when you signed up to use our API", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property ApiUserId As String

            '''<Summary>
            '''The API User Key provided by us when you signed up to use our API
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The API User Key provided by us when you signed up to use our API", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property ApiUserKey As String
        End Class

        Public Partial Class CompanyDirectorOrShareholder
            Public Overridable Property Id As Long
            Public Overridable Property SearchType As String
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property NumOfResults As Integer
            Public Overridable Property ClientInResults As Boolean
            Public Overridable Property ClientNotInResults As Boolean
            Public Overridable Property AffectedByUpdate As Boolean
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property IsDirector As Boolean
            Public Overridable Property IsShareholder As Boolean
        End Class

        Public Partial Class CompanyLookupEnhanced
            Public Sub New()
                SicCodes = New List(Of CompanyLookupEnhancedSicCode)
                PreviousNames = New List(Of CompanyLookupEnhancedPreviousName)
                EventHistory = New List(Of CompanyLookupEnhancedEvent)
                Commentaries = New List(Of CompanyLookupEnhancedCommentary)
                FinancialStatements = New List(Of CompanyLookupEnhancedFinancialStatement)
            End Sub

            Public Overridable Property Summary As CompanyLookupEnhancedSummary
            Public Overridable Property ContactInformation As CompanyLookupEnhancedContactInfo
            Public Overridable Property SicCodes As List(Of CompanyLookupEnhancedSicCode)
            Public Overridable Property PreviousNames As List(Of CompanyLookupEnhancedPreviousName)
            Public Overridable Property ShareStructure As CompanyLookupEnhancedShareStructure
            Public Overridable Property Directors As CompanyLookupEnhancedDirectors
            Public Overridable Property GroupStructure As CompanyLookupEnhancedStructure
            Public Overridable Property CountyCourtJudgements As CompanyLookupEnhancedCCJs
            Public Overridable Property EventHistory As List(Of CompanyLookupEnhancedEvent)
            Public Overridable Property Commentaries As List(Of CompanyLookupEnhancedCommentary)
            Public Overridable Property CreditAccounts As CompanyLookupEnhancedCreditAccount
            Public Overridable Property FinancialStatements As List(Of CompanyLookupEnhancedFinancialStatement)
        End Class

        Public Partial Class CompanyLookupEnhancedAdditionalContact
            Public Overridable Property Telephone As String
            Public Overridable Property FaxNumber As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property WebAddress As String
            Public Overridable Property Twitter As String
            Public Overridable Property Facebook As String
            Public Overridable Property GooglePlus As String
            Public Overridable Property LinkedIn As String
            Public Overridable Property ContactName As String
            Public Overridable Property BusinessClassification As String
        End Class

        Public Partial Class CompanyLookupEnhancedAddress
            Public Overridable Property FullAddress As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property Address4 As String
            Public Overridable Property PostCode As String
            Public Overridable Property Telephone As String
        End Class

        Public Partial Class CompanyLookupEnhancedCCJ
            Public Overridable Property [Date] As Nullable(Of Date)
            Public Overridable Property Court As String
            Public Overridable Property Amount As Nullable(Of Decimal)
            Public Overridable Property CaseNumber As String
            Public Overridable Property Status As String
            Public Overridable Property DatePaid As String
            Public Overridable Property IncomingRecordDetails As String
        End Class

        Public Partial Class CompanyLookupEnhancedCCJs
            Public Sub New()
                PossibleCCJs = New List(Of CompanyLookupEnhancedCCJ)
                ExactCCJs = New List(Of CompanyLookupEnhancedCCJ)
            End Sub

            Public Overridable Property PossibleCCJs As List(Of CompanyLookupEnhancedCCJ)
            Public Overridable Property ExactCCJs As List(Of CompanyLookupEnhancedCCJ)
        End Class

        Public Partial Class CompanyLookupEnhancedCommentary
            Public Overridable Property Text As String
            Public Overridable Property PositiveOrNegative As String
            Public Overridable Property Priority As Nullable(Of Integer)
        End Class

        Public Partial Class CompanyLookupEnhancedCompany
            Public Overridable Property Country As String
            Public Overridable Property CompanyName As String
            Public Overridable Property CompanyNumber As String
        End Class

        Public Partial Class CompanyLookupEnhancedContactInfo
            Public Sub New()
                TradingAddresses = New List(Of CompanyLookupEnhancedAddress)
                Websites = New List(Of CompanyLookupEnhancedWebsite)
            End Sub

            Public Overridable Property RegisteredAddress As CompanyLookupEnhancedAddress
            Public Overridable Property TradingAddresses As List(Of CompanyLookupEnhancedAddress)
            Public Overridable Property Websites As List(Of CompanyLookupEnhancedWebsite)
            Public Overridable Property AdditionalContactInfo As CompanyLookupEnhancedAdditionalContact
        End Class

        Public Partial Class CompanyLookupEnhancedCreditAccount
            Public Sub New()
                CreditLimitHistory = New List(Of CompanyLookupEnhancedCreditLimit)
                CreditRatingHistory = New List(Of CompanyLookupEnhancedCreditRating)
            End Sub

            Public Overridable Property CreditLimitHistory As List(Of CompanyLookupEnhancedCreditLimit)
            Public Overridable Property CreditRatingHistory As List(Of CompanyLookupEnhancedCreditRating)
        End Class

        Public Partial Class CompanyLookupEnhancedCreditLimit
            Public Overridable Property [Date] As Nullable(Of Date)
            Public Overridable Property DateOrder As Nullable(Of Integer)
            Public Overridable Property Amount As Nullable(Of Integer)
        End Class

        Public Partial Class CompanyLookupEnhancedCreditRating
            Public Overridable Property [Date] As Nullable(Of Date)
            Public Overridable Property DateOrder As Nullable(Of Integer)
            Public Overridable Property Amount As Nullable(Of Integer)
            Public Overridable Property ShortDescription As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class CompanyLookupEnhancedDirector
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property Gender As String
            Public Overridable Property AppointmentDate As Nullable(Of Date)
            Public Overridable Property ResignationDate As Nullable(Of Date)
            Public Overridable Property DateOfBirth As Nullable(Of Date)
            Public Overridable Property Position As String
            Public Overridable Property IdNumber As Nullable(Of Integer)
            Public Overridable Property CurrentDirectorships As Nullable(Of Integer)
            Public Overridable Property PreviousDirectorships As Nullable(Of Integer)
            Public Overridable Property TotalDirectorships As Nullable(Of Integer)
        End Class

        Public Partial Class CompanyLookupEnhancedDirectors
            Public Sub New()
                CurrentDirectors = New List(Of CompanyLookupEnhancedDirector)
                PreviousDirectors = New List(Of CompanyLookupEnhancedDirector)
            End Sub

            Public Overridable Property CurrentDirectors As List(Of CompanyLookupEnhancedDirector)
            Public Overridable Property PreviousDirectors As List(Of CompanyLookupEnhancedDirector)
        End Class

        Public Partial Class CompanyLookupEnhancedEvent
            Public Overridable Property [Date] As Nullable(Of Date)
            Public Overridable Property Description As String
        End Class

        Public Partial Class CompanyLookupEnhancedFinancialStatement
            Public Overridable Property YearEndDateOrder As Nullable(Of Integer)
            Public Overridable Property YearEndDate As Nullable(Of Date)
            Public Overridable Property SummaryNumberOfWeeks As Nullable(Of Integer)
            Public Overridable Property SummaryCurrency As String
            Public Overridable Property SummaryConsolidatedAccount As String
            Public Overridable Property ProfitAndLoss As CompanyLookupFinancialProfit
            Public Overridable Property BalanceSheet As CompanyLookupFinancialBalance
            Public Overridable Property CapitalAndReserves As CompanyLookupFinancialCapital
            Public Overridable Property Other As CompanyLookupFinancialOther
            Public Overridable Property Cash As CompanyLookupFinancialCash
            Public Overridable Property Misc As CompanyLookupFinancialMisc
            Public Overridable Property Ratios As CompanyLookupFinancialRatios
        End Class

        Public Partial Class CompanyLookupEnhancedLatestAccounts
            Public Overridable Property Currency As String
            Public Overridable Property Turnover As Nullable(Of Decimal)
            Public Overridable Property ShareholdersEquity As Nullable(Of Decimal)
            Public Overridable Property CreditRating As Nullable(Of Integer)
            Public Overridable Property CreditLimit As Nullable(Of Integer)
            Public Overridable Property CreditRatingDescription As String
            Public Overridable Property AccountRefDay As Nullable(Of Integer)
            Public Overridable Property AccountRefMonth As Nullable(Of Integer)
            Public Overridable Property AccountNextDueDate As Nullable(Of Date)
            Public Overridable Property AccountLastMadeUpDate As Nullable(Of Date)
            Public Overridable Property AccountCategory As String
            Public Overridable Property ReturnLastMadeUpDate As Nullable(Of Date)
        End Class

        Public Partial Class CompanyLookupEnhancedPreviousName
            Public Overridable Property DateChanged As Nullable(Of Date)
            Public Overridable Property Name As String
        End Class

        Public Partial Class CompanyLookupEnhancedShareholder
            Public Overridable Property Title As String
            Public Overridable Property Forename As String
            Public Overridable Property Surname As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property Address4 As String
            Public Overridable Property Address5 As String
            Public Overridable Property PostCode As String
            Public Overridable Property ShareType As String
            Public Overridable Property Number As Nullable(Of Decimal)
            Public Overridable Property Value As Nullable(Of Decimal)
            Public Overridable Property Currency As String
            Public Overridable Property ShareholderType As String
            Public Overridable Property ShareClass As String
        End Class

        Public Partial Class CompanyLookupEnhancedShareStructure
            Public Sub New()
                Shareholders = New List(Of CompanyLookupEnhancedShareholder)
            End Sub

            Public Overridable Property IssuedShareCapital As Nullable(Of Decimal)
            Public Overridable Property Shareholders As List(Of CompanyLookupEnhancedShareholder)
        End Class

        Public Partial Class CompanyLookupEnhancedSicCode
            Public Overridable Property SicCode2003 As Nullable(Of Integer)
            Public Overridable Property SicCode2003Description As String
            Public Overridable Property SicCode2007 As Nullable(Of Integer)
            Public Overridable Property SicCode2007Description As String
            Public Overridable Property Status As String
        End Class

        Public Partial Class CompanyLookupEnhancedStructure
            Public Sub New()
                ParentCompanies = New List(Of CompanyLookupEnhancedCompany)
                SubsidiaryCompanies = New List(Of CompanyLookupEnhancedCompany)
            End Sub

            Public Overridable Property ParentCompanies As List(Of CompanyLookupEnhancedCompany)
            Public Overridable Property SubsidiaryCompanies As List(Of CompanyLookupEnhancedCompany)
        End Class

        Public Partial Class CompanyLookupEnhancedSummary
            Public Overridable Property Name As String
            Public Overridable Property Country As String
            Public Overridable Property RegistrationNumber As String
            Public Overridable Property DateOfIncorporation As String
            Public Overridable Property TypeOfIncorporation As String
            Public Overridable Property CompanyStatus As String
            Public Overridable Property Address As String
            Public Overridable Property Telephone As String
            Public Overridable Property SicCode As String
            Public Overridable Property SicDescription As String
            Public Overridable Property PrincipleActivity As String
            Public Overridable Property LatestAccounts As CompanyLookupEnhancedLatestAccounts
        End Class

        Public Partial Class CompanyLookupEnhancedWebsite
            Public Overridable Property Website As String
        End Class

        Public Partial Class CompanyLookupFinancialBalance
            Public Overridable Property TangibleAccounts As Nullable(Of Decimal)
            Public Overridable Property IntangibleAssets As Nullable(Of Decimal)
            Public Overridable Property TotalFixedAssets As Nullable(Of Decimal)
            Public Overridable Property Stock As Nullable(Of Decimal)
            Public Overridable Property TradeDebtors As Nullable(Of Decimal)
            Public Overridable Property Cash As Nullable(Of Decimal)
            Public Overridable Property OtherDebtors As Nullable(Of Decimal)
            Public Overridable Property MiscCurrentAssets As Nullable(Of Decimal)
            Public Overridable Property TotalCurrentAssets As Nullable(Of Decimal)
            Public Overridable Property TradeCreditors As Nullable(Of Decimal)
            Public Overridable Property BankLoansAndOverdrafts As Nullable(Of Decimal)
            Public Overridable Property OtherShortTermFinance As Nullable(Of Decimal)
            Public Overridable Property MiscCurrentLiabilities As Nullable(Of Decimal)
            Public Overridable Property TotalCurrentLiabilities As Nullable(Of Decimal)
            Public Overridable Property BankLoansAndOverdraftsAndLTL As Nullable(Of Decimal)
            Public Overridable Property OtherLongTermFinance As Nullable(Of Decimal)
            Public Overridable Property TotalLongTermFinance As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupFinancialCapital
            Public Overridable Property CalledUpSharedCapital As Nullable(Of Decimal)
            Public Overridable Property ProfitAndLossAccountReserve As Nullable(Of Decimal)
            Public Overridable Property RevaluationReserve As Nullable(Of Decimal)
            Public Overridable Property SundryReserves As Nullable(Of Decimal)
            Public Overridable Property ShareholderFunds As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupFinancialCash
            Public Overridable Property NetCashFlowFromOperations As Nullable(Of Decimal)
            Public Overridable Property NetCashFlowBeforeFinancing As Nullable(Of Decimal)
            Public Overridable Property NetCashFlowFromFinancing As Nullable(Of Decimal)
            Public Overridable Property IncreaseInCash As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupFinancialMisc
            Public Overridable Property ContingentLiability As String
            Public Overridable Property CapitalEmployed As Nullable(Of Decimal)
            Public Overridable Property NumberOfEmployees As Nullable(Of Decimal)
            Public Overridable Property Auditors As String
            Public Overridable Property AuditorComments As String
            Public Overridable Property Bankers As String
            Public Overridable Property BankBranchCode As String
        End Class

        Public Partial Class CompanyLookupFinancialOther
            Public Overridable Property NetWorth As Nullable(Of Decimal)
            Public Overridable Property NetAssets As Nullable(Of Decimal)
            Public Overridable Property WorkingCapital As Nullable(Of Decimal)
            Public Overridable Property TotalAssets As Nullable(Of Decimal)
            Public Overridable Property TotalLiabilities As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupFinancialProfit
            Public Overridable Property Turnover As Nullable(Of Decimal)
            Public Overridable Property Export As Nullable(Of Decimal)
            Public Overridable Property CostOfSales As Nullable(Of Decimal)
            Public Overridable Property GrossProfit As Nullable(Of Decimal)
            Public Overridable Property WagesAndSalaries As Nullable(Of Decimal)
            Public Overridable Property DirectorEmolument As Nullable(Of Decimal)
            Public Overridable Property OperatingProfit As Nullable(Of Decimal)
            Public Overridable Property Depreciation As Nullable(Of Decimal)
            Public Overridable Property AuditFees As Nullable(Of Decimal)
            Public Overridable Property InterestPayments As Nullable(Of Decimal)
            Public Overridable Property PretaxProfit As Nullable(Of Decimal)
            Public Overridable Property Taxation As Nullable(Of Decimal)
            Public Overridable Property ProfitAfterTax As Nullable(Of Decimal)
            Public Overridable Property DividendsPayable As Nullable(Of Decimal)
            Public Overridable Property RetainedProfit As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupFinancialRatios
            Public Overridable Property PreTaxProfitMargin As Nullable(Of Decimal)
            Public Overridable Property CurrentRatio As Nullable(Of Decimal)
            Public Overridable Property SalesNetworkingCapital As Nullable(Of Decimal)
            Public Overridable Property Gearing As Nullable(Of Decimal)
            Public Overridable Property Equity As Nullable(Of Decimal)
            Public Overridable Property CreditorDays As Nullable(Of Decimal)
            Public Overridable Property DebtorDays As Nullable(Of Decimal)
            Public Overridable Property LiquidityAcidTest As Nullable(Of Decimal)
            Public Overridable Property ReturnOnCapitalEmployed As Nullable(Of Decimal)
            Public Overridable Property ReturnOnNetAssetsEmployed As Nullable(Of Decimal)
            Public Overridable Property ReturnOnTotalAssetsEmployed As Nullable(Of Decimal)
            Public Overridable Property CurrentDebtRatio As Nullable(Of Decimal)
            Public Overridable Property TotalDebtRatio As Nullable(Of Decimal)
            Public Overridable Property StockTurnoverRatio As Nullable(Of Decimal)
        End Class

        Public Partial Class CompanyLookupSearchRecord
            Public Sub New()
                CompanyDirectorsAndShareholders = New List(Of CompanyDirectorOrShareholder)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property SelectedLists As ArrayOfLists
            Public Overridable Property [Date] As Date
            Public Overridable Property HasCompanyId As Boolean
            Public Overridable Property HasCompanyDetails As Boolean
            Public Overridable Property HasStartedSearches As Boolean
            Public Overridable Property HasCompletedSearches As Boolean
            Public Overridable Property CompanyDirectorsAndShareholders As List(Of CompanyDirectorOrShareholder)
            Public Overridable Property CompanySearchRecord As SearchListItem
            Public Overridable Property HasEnhancedInformation As Boolean
            Public Overridable Property EnhancedInformation As CompanyLookupEnhanced
        End Class

        Public Partial Class LinkedTo
            Public Overridable Property ClientId As Nullable(Of Integer)
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property Type As String
            Public Overridable Property Subtype As String
            Public Overridable Property Status As String
            Public Overridable Property Description As String
            Public Overridable Property IsArchived As Nullable(Of Boolean)
            Public Overridable Property Name As String
            Public Overridable Property [Date] As Nullable(Of Date)
        End Class

        Public Partial Class SearchCriteria
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property Country As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Nationality As String
            Public Overridable Property Reference As String
        End Class

        Public Partial Class SearchListItem
            Public Sub New()
                SearchSources = New List(Of SearchSource)
            End Sub

            Public Overridable Property Id As Long
            Public Overridable Property SearchType As String
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property DateArchived As Nullable(Of Date)
            Public Overridable Property IsArchived As Boolean
            Public Overridable Property NumOfResults As Integer
            Public Overridable Property ClientInResults As Boolean
            Public Overridable Property ClientNotInResults As Boolean
            Public Overridable Property AffectedByUpdate As Boolean
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property SearchSources As List(Of SearchSource)
        End Class

        Public Partial Class SearchSource
            Public Overridable Property ListId As String
            Public Overridable Property ListName As String
            Public Overridable Property ListShortName As String
            Public Overridable Property IsAffectedByListUpdate As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET AddCompanyLookup 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 /companylookups/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCompanyLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <CompanyAddress>String</CompanyAddress>
    <CompanyCountry>String</CompanyCountry>
    <CompanyLookupId>0</CompanyLookupId>
    <CompanyName>String</CompanyName>
    <CompanyRegistrationNumber>String</CompanyRegistrationNumber>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <PerformEnhancedSearch>false</PerformEnhancedSearch>
    <SelectedLists>
      <ListId>String</ListId>
    </SelectedLists>
    <SubUserName>String</SubUserName>
  </Request>
</AddCompanyLookup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddCompanyLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <SearchRecord>
      <CompanyDirectorsAndShareholders>
        <CompanyDirectorOrShareholder>
          <AffectedByUpdate>false</AffectedByUpdate>
          <ClientInResults>false</ClientInResults>
          <ClientNotInResults>false</ClientNotInResults>
          <DateSearched>0001-01-01T00:00:00</DateSearched>
          <DateUpdated>0001-01-01T00:00:00</DateUpdated>
          <Id>0</Id>
          <IsDirector>false</IsDirector>
          <IsShareholder>false</IsShareholder>
          <NumOfResults>0</NumOfResults>
          <SearchCriteria>
            <Address>String</Address>
            <Country>String</Country>
            <DateOfBirth>String</DateOfBirth>
            <Name>String</Name>
            <Nationality>String</Nationality>
            <Reference>String</Reference>
          </SearchCriteria>
          <SearchType>String</SearchType>
        </CompanyDirectorOrShareholder>
      </CompanyDirectorsAndShareholders>
      <CompanySearchRecord>
        <AffectedByUpdate>false</AffectedByUpdate>
        <ClientInResults>false</ClientInResults>
        <ClientNotInResults>false</ClientNotInResults>
        <DateArchived>0001-01-01T00:00:00</DateArchived>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <DateUpdated>0001-01-01T00:00:00</DateUpdated>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <NumOfResults>0</NumOfResults>
        <SearchCriteria>
          <Address>String</Address>
          <Country>String</Country>
          <DateOfBirth>String</DateOfBirth>
          <Name>String</Name>
          <Nationality>String</Nationality>
          <Reference>String</Reference>
        </SearchCriteria>
        <SearchSources>
          <SearchSource>
            <IsAffectedByListUpdate>false</IsAffectedByListUpdate>
            <ListId>String</ListId>
            <ListName>String</ListName>
            <ListShortName>String</ListShortName>
          </SearchSource>
        </SearchSources>
        <SearchType>String</SearchType>
      </CompanySearchRecord>
      <Date>0001-01-01T00:00:00</Date>
      <EnhancedInformation>
        <Commentaries>
          <CompanyLookupEnhancedCommentary>
            <PositiveOrNegative>String</PositiveOrNegative>
            <Priority>0</Priority>
            <Text>String</Text>
          </CompanyLookupEnhancedCommentary>
        </Commentaries>
        <ContactInformation>
          <AdditionalContactInfo>
            <BusinessClassification>String</BusinessClassification>
            <ContactName>String</ContactName>
            <EmailAddress>String</EmailAddress>
            <Facebook>String</Facebook>
            <FaxNumber>String</FaxNumber>
            <GooglePlus>String</GooglePlus>
            <LinkedIn>String</LinkedIn>
            <Telephone>String</Telephone>
            <Twitter>String</Twitter>
            <WebAddress>String</WebAddress>
          </AdditionalContactInfo>
          <RegisteredAddress>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <Address3>String</Address3>
            <Address4>String</Address4>
            <FullAddress>String</FullAddress>
            <PostCode>String</PostCode>
            <Telephone>String</Telephone>
          </RegisteredAddress>
          <TradingAddresses>
            <CompanyLookupEnhancedAddress>
              <Address1>String</Address1>
              <Address2>String</Address2>
              <Address3>String</Address3>
              <Address4>String</Address4>
              <FullAddress>String</FullAddress>
              <PostCode>String</PostCode>
              <Telephone>String</Telephone>
            </CompanyLookupEnhancedAddress>
          </TradingAddresses>
          <Websites>
            <CompanyLookupEnhancedWebsite>
              <Website>String</Website>
            </CompanyLookupEnhancedWebsite>
          </Websites>
        </ContactInformation>
        <CountyCourtJudgements>
          <ExactCCJs>
            <CompanyLookupEnhancedCCJ>
              <Amount>0</Amount>
              <CaseNumber>String</CaseNumber>
              <Court>String</Court>
              <Date>0001-01-01T00:00:00</Date>
              <DatePaid>String</DatePaid>
              <IncomingRecordDetails>String</IncomingRecordDetails>
              <Status>String</Status>
            </CompanyLookupEnhancedCCJ>
          </ExactCCJs>
          <PossibleCCJs>
            <CompanyLookupEnhancedCCJ>
              <Amount>0</Amount>
              <CaseNumber>String</CaseNumber>
              <Court>String</Court>
              <Date>0001-01-01T00:00:00</Date>
              <DatePaid>String</DatePaid>
              <IncomingRecordDetails>String</IncomingRecordDetails>
              <Status>String</Status>
            </CompanyLookupEnhancedCCJ>
          </PossibleCCJs>
        </CountyCourtJudgements>
        <CreditAccounts>
          <CreditLimitHistory>
            <CompanyLookupEnhancedCreditLimit>
              <Amount>0</Amount>
              <Date>0001-01-01T00:00:00</Date>
              <DateOrder>0</DateOrder>
            </CompanyLookupEnhancedCreditLimit>
          </CreditLimitHistory>
          <CreditRatingHistory>
            <CompanyLookupEnhancedCreditRating>
              <Amount>0</Amount>
              <Date>0001-01-01T00:00:00</Date>
              <DateOrder>0</DateOrder>
              <Description>String</Description>
              <ShortDescription>String</ShortDescription>
            </CompanyLookupEnhancedCreditRating>
          </CreditRatingHistory>
        </CreditAccounts>
        <Directors>
          <CurrentDirectors>
            <CompanyLookupEnhancedDirector>
              <Address>String</Address>
              <AppointmentDate>0001-01-01T00:00:00</AppointmentDate>
              <CurrentDirectorships>0</CurrentDirectorships>
              <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
              <Gender>String</Gender>
              <IdNumber>0</IdNumber>
              <Name>String</Name>
              <Position>String</Position>
              <PreviousDirectorships>0</PreviousDirectorships>
              <ResignationDate>0001-01-01T00:00:00</ResignationDate>
              <TotalDirectorships>0</TotalDirectorships>
            </CompanyLookupEnhancedDirector>
          </CurrentDirectors>
          <PreviousDirectors>
            <CompanyLookupEnhancedDirector>
              <Address>String</Address>
              <AppointmentDate>0001-01-01T00:00:00</AppointmentDate>
              <CurrentDirectorships>0</CurrentDirectorships>
              <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
              <Gender>String</Gender>
              <IdNumber>0</IdNumber>
              <Name>String</Name>
              <Position>String</Position>
              <PreviousDirectorships>0</PreviousDirectorships>
              <ResignationDate>0001-01-01T00:00:00</ResignationDate>
              <TotalDirectorships>0</TotalDirectorships>
            </CompanyLookupEnhancedDirector>
          </PreviousDirectors>
        </Directors>
        <EventHistory>
          <CompanyLookupEnhancedEvent>
            <Date>0001-01-01T00:00:00</Date>
            <Description>String</Description>
          </CompanyLookupEnhancedEvent>
        </EventHistory>
        <FinancialStatements>
          <CompanyLookupEnhancedFinancialStatement>
            <BalanceSheet>
              <BankLoansAndOverdrafts>0</BankLoansAndOverdrafts>
              <BankLoansAndOverdraftsAndLTL>0</BankLoansAndOverdraftsAndLTL>
              <Cash>0</Cash>
              <IntangibleAssets>0</IntangibleAssets>
              <MiscCurrentAssets>0</MiscCurrentAssets>
              <MiscCurrentLiabilities>0</MiscCurrentLiabilities>
              <OtherDebtors>0</OtherDebtors>
              <OtherLongTermFinance>0</OtherLongTermFinance>
              <OtherShortTermFinance>0</OtherShortTermFinance>
              <Stock>0</Stock>
              <TangibleAccounts>0</TangibleAccounts>
              <TotalCurrentAssets>0</TotalCurrentAssets>
              <TotalCurrentLiabilities>0</TotalCurrentLiabilities>
              <TotalFixedAssets>0</TotalFixedAssets>
              <TotalLongTermFinance>0</TotalLongTermFinance>
              <TradeCreditors>0</TradeCreditors>
              <TradeDebtors>0</TradeDebtors>
            </BalanceSheet>
            <CapitalAndReserves>
              <CalledUpSharedCapital>0</CalledUpSharedCapital>
              <ProfitAndLossAccountReserve>0</ProfitAndLossAccountReserve>
              <RevaluationReserve>0</RevaluationReserve>
              <ShareholderFunds>0</ShareholderFunds>
              <SundryReserves>0</SundryReserves>
            </CapitalAndReserves>
            <Cash>
              <IncreaseInCash>0</IncreaseInCash>
              <NetCashFlowBeforeFinancing>0</NetCashFlowBeforeFinancing>
              <NetCashFlowFromFinancing>0</NetCashFlowFromFinancing>
              <NetCashFlowFromOperations>0</NetCashFlowFromOperations>
            </Cash>
            <Misc>
              <AuditorComments>String</AuditorComments>
              <Auditors>String</Auditors>
              <BankBranchCode>String</BankBranchCode>
              <Bankers>String</Bankers>
              <CapitalEmployed>0</CapitalEmployed>
              <ContingentLiability>String</ContingentLiability>
              <NumberOfEmployees>0</NumberOfEmployees>
            </Misc>
            <Other>
              <NetAssets>0</NetAssets>
              <NetWorth>0</NetWorth>
              <TotalAssets>0</TotalAssets>
              <TotalLiabilities>0</TotalLiabilities>
              <WorkingCapital>0</WorkingCapital>
            </Other>
            <ProfitAndLoss>
              <AuditFees>0</AuditFees>
              <CostOfSales>0</CostOfSales>
              <Depreciation>0</Depreciation>
              <DirectorEmolument>0</DirectorEmolument>
              <DividendsPayable>0</DividendsPayable>
              <Export>0</Export>
              <GrossProfit>0</GrossProfit>
              <InterestPayments>0</InterestPayments>
              <OperatingProfit>0</OperatingProfit>
              <PretaxProfit>0</PretaxProfit>
              <ProfitAfterTax>0</ProfitAfterTax>
              <RetainedProfit>0</RetainedProfit>
              <Taxation>0</Taxation>
              <Turnover>0</Turnover>
              <WagesAndSalaries>0</WagesAndSalaries>
            </ProfitAndLoss>
            <Ratios>
              <CreditorDays>0</CreditorDays>
              <CurrentDebtRatio>0</CurrentDebtRatio>
              <CurrentRatio>0</CurrentRatio>
              <DebtorDays>0</DebtorDays>
              <Equity>0</Equity>
              <Gearing>0</Gearing>
              <LiquidityAcidTest>0</LiquidityAcidTest>
              <PreTaxProfitMargin>0</PreTaxProfitMargin>
              <ReturnOnCapitalEmployed>0</ReturnOnCapitalEmployed>
              <ReturnOnNetAssetsEmployed>0</ReturnOnNetAssetsEmployed>
              <ReturnOnTotalAssetsEmployed>0</ReturnOnTotalAssetsEmployed>
              <SalesNetworkingCapital>0</SalesNetworkingCapital>
              <StockTurnoverRatio>0</StockTurnoverRatio>
              <TotalDebtRatio>0</TotalDebtRatio>
            </Ratios>
            <SummaryConsolidatedAccount>String</SummaryConsolidatedAccount>
            <SummaryCurrency>String</SummaryCurrency>
            <SummaryNumberOfWeeks>0</SummaryNumberOfWeeks>
            <YearEndDate>0001-01-01T00:00:00</YearEndDate>
            <YearEndDateOrder>0</YearEndDateOrder>
          </CompanyLookupEnhancedFinancialStatement>
        </FinancialStatements>
        <GroupStructure>
          <ParentCompanies>
            <CompanyLookupEnhancedCompany>
              <CompanyName>String</CompanyName>
              <CompanyNumber>String</CompanyNumber>
              <Country>String</Country>
            </CompanyLookupEnhancedCompany>
          </ParentCompanies>
          <SubsidiaryCompanies>
            <CompanyLookupEnhancedCompany>
              <CompanyName>String</CompanyName>
              <CompanyNumber>String</CompanyNumber>
              <Country>String</Country>
            </CompanyLookupEnhancedCompany>
          </SubsidiaryCompanies>
        </GroupStructure>
        <PreviousNames>
          <CompanyLookupEnhancedPreviousName>
            <DateChanged>0001-01-01T00:00:00</DateChanged>
            <Name>String</Name>
          </CompanyLookupEnhancedPreviousName>
        </PreviousNames>
        <ShareStructure>
          <IssuedShareCapital>0</IssuedShareCapital>
          <Shareholders>
            <CompanyLookupEnhancedShareholder>
              <Address1>String</Address1>
              <Address2>String</Address2>
              <Address3>String</Address3>
              <Address4>String</Address4>
              <Address5>String</Address5>
              <Currency>String</Currency>
              <Forename>String</Forename>
              <Number>0</Number>
              <PostCode>String</PostCode>
              <ShareClass>String</ShareClass>
              <ShareType>String</ShareType>
              <ShareholderType>String</ShareholderType>
              <Surname>String</Surname>
              <Title>String</Title>
              <Value>0</Value>
            </CompanyLookupEnhancedShareholder>
          </Shareholders>
        </ShareStructure>
        <SicCodes>
          <CompanyLookupEnhancedSicCode>
            <SicCode2003>0</SicCode2003>
            <SicCode2003Description>String</SicCode2003Description>
            <SicCode2007>0</SicCode2007>
            <SicCode2007Description>String</SicCode2007Description>
            <Status>String</Status>
          </CompanyLookupEnhancedSicCode>
        </SicCodes>
        <Summary>
          <Address>String</Address>
          <CompanyStatus>String</CompanyStatus>
          <Country>String</Country>
          <DateOfIncorporation>String</DateOfIncorporation>
          <LatestAccounts>
            <AccountCategory>String</AccountCategory>
            <AccountLastMadeUpDate>0001-01-01T00:00:00</AccountLastMadeUpDate>
            <AccountNextDueDate>0001-01-01T00:00:00</AccountNextDueDate>
            <AccountRefDay>0</AccountRefDay>
            <AccountRefMonth>0</AccountRefMonth>
            <CreditLimit>0</CreditLimit>
            <CreditRating>0</CreditRating>
            <CreditRatingDescription>String</CreditRatingDescription>
            <Currency>String</Currency>
            <ReturnLastMadeUpDate>0001-01-01T00:00:00</ReturnLastMadeUpDate>
            <ShareholdersEquity>0</ShareholdersEquity>
            <Turnover>0</Turnover>
          </LatestAccounts>
          <Name>String</Name>
          <PrincipleActivity>String</PrincipleActivity>
          <RegistrationNumber>String</RegistrationNumber>
          <SicCode>String</SicCode>
          <SicDescription>String</SicDescription>
          <Telephone>String</Telephone>
          <TypeOfIncorporation>String</TypeOfIncorporation>
        </Summary>
      </EnhancedInformation>
      <HasCompanyDetails>false</HasCompanyDetails>
      <HasCompanyId>false</HasCompanyId>
      <HasCompletedSearches>false</HasCompletedSearches>
      <HasEnhancedInformation>false</HasEnhancedInformation>
      <HasStartedSearches>false</HasStartedSearches>
      <Id>0</Id>
      <SearchCriteria>
        <Address>String</Address>
        <Country>String</Country>
        <DateOfBirth>String</DateOfBirth>
        <Name>String</Name>
        <Nationality>String</Nationality>
        <Reference>String</Reference>
      </SearchCriteria>
      <SelectedLists>
        <ListId>String</ListId>
      </SelectedLists>
    </SearchRecord>
  </Data>
</AddCompanyLookupResponse>