DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

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

Namespace Global

    Namespace IDB.CompanyLookup.DTO

        Public Partial Class CompanyLookupEntry
            Public Overridable Property ChamberNr As String
            Public Overridable Property ChamberEstablishmentNumber As String
            Public Overridable Property LegalName As String
            Public Overridable Property TradeName As String
            Public Overridable Property MatchType As String
            Public Overridable Property EstablishmentCity As String
            Public Overridable Property EstablishmentStreet As String
            Public Overridable Property CorrespondenceCity As String
            Public Overridable Property CorrespondenceStreet As String
            Public Overridable Property IndicationMainEstablishment As Nullable(Of Boolean)
        End Class

        Public Partial Class CompanyLookupSearchResults
            Public Sub New()
                Results = New List(Of CompanyLookupEntry)
            End Sub

            Public Overridable Property Results As List(Of CompanyLookupEntry)
            Public Overridable Property PagingResultsInfo As PagingResultsInfo
        End Class

        Public Partial Class PagingResultsInfo
            Public Overridable Property CurrentPage As Integer
            Public Overridable Property MaxResultsPerPage As Integer
            Public Overridable Property NumberOfPages As Integer
            Public Overridable Property NumberOfResults As Integer
            Public Overridable Property MaximumResults As Integer
        End Class
    End Namespace

    Namespace IDB.CompanyLookup.DTO.Operations

        Public Partial Class GetCompaniesLookup
            Public Overridable Property ChamberNr As String
            Public Overridable Property TradeName As String
            Public Overridable Property City As String
        End Class
    End Namespace
End Namespace

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"Results":[],"PagingResultsInfo":{"CurrentPage":0,"MaxResultsPerPage":0,"NumberOfPages":0,"NumberOfResults":0,"MaximumResults":0}}