DigiOffice Gateway Web Services

<back to all web services

GetCompanyLookupDetails

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup/{ChamberNr}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.CompanyLookup.DTO

Namespace Global

    Namespace IDB.CompanyLookup.DTO

        Public Partial Class CompanyLookupDetails
            Public Sub New()
                ExtraFields = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property ChamberNr As String
            Public Overridable Property ChamberEstablishmentNumber As String
            Public Overridable Property CompanyLegalName As String
            Public Overridable Property CompanyTradeName As String
            Public Overridable Property ChamberCity As String
            Public Overridable Property ChamberFoundingDate As Nullable(Of Date)
            Public Overridable Property EstablishmentStreet As String
            Public Overridable Property EstablishmentHouseNr As String
            Public Overridable Property EstablishmentHouseNrAddition As String
            Public Overridable Property EstablishmentPostalCode As String
            Public Overridable Property EstablishmentCity As String
            Public Overridable Property EstablishmentCountryTLA As String
            Public Overridable Property CorrespondencePOBox As String
            Public Overridable Property CorrespondencePostalCode As String
            Public Overridable Property CorrespondenceCity As String
            Public Overridable Property CorrespondenceCountryTLA As String
            Public Overridable Property Website As String
            Public Overridable Property Telephone As String
            Public Overridable Property Mobile As String
            Public Overridable Property EMail As String
            Public Overridable Property DebtorInPossession As Boolean
            Public Overridable Property Bankrupt As Boolean
            Public Overridable Property ExtraFields As Dictionary(Of String, Object)
        End Class

        Public Partial Class GetCompanyLookupDetails
            Public Overridable Property ChamberNr As String
            Public Overridable Property ChamberEstablishmentNumber As String
        End Class
    End Namespace
End Namespace

VB.NET GetCompanyLookupDetails 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.

GET /api/companies/lookup/{ChamberNr} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyLookupDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.CompanyLookup.DTO">
  <Bankrupt>false</Bankrupt>
  <ChamberCity>String</ChamberCity>
  <ChamberEstablishmentNumber>String</ChamberEstablishmentNumber>
  <ChamberFoundingDate>0001-01-01T00:00:00</ChamberFoundingDate>
  <ChamberNr>String</ChamberNr>
  <CompanyLegalName>String</CompanyLegalName>
  <CompanyTradeName>String</CompanyTradeName>
  <CorrespondenceCity>String</CorrespondenceCity>
  <CorrespondenceCountryTLA>String</CorrespondenceCountryTLA>
  <CorrespondencePOBox>String</CorrespondencePOBox>
  <CorrespondencePostalCode>String</CorrespondencePostalCode>
  <DebtorInPossession>false</DebtorInPossession>
  <EMail>String</EMail>
  <EstablishmentCity>String</EstablishmentCity>
  <EstablishmentCountryTLA>String</EstablishmentCountryTLA>
  <EstablishmentHouseNr>String</EstablishmentHouseNr>
  <EstablishmentHouseNrAddition>String</EstablishmentHouseNrAddition>
  <EstablishmentPostalCode>String</EstablishmentPostalCode>
  <EstablishmentStreet>String</EstablishmentStreet>
  <ExtraFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ExtraFields>
  <Mobile>String</Mobile>
  <Telephone>String</Telephone>
  <Website>String</Website>
</CompanyLookupDetails>