DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyLookupEntry:
    chamber_nr: Optional[str] = None
    chamber_establishment_number: Optional[str] = None
    legal_name: Optional[str] = None
    trade_name: Optional[str] = None
    match_type: Optional[str] = None
    establishment_city: Optional[str] = None
    establishment_street: Optional[str] = None
    correspondence_city: Optional[str] = None
    correspondence_street: Optional[str] = None
    indication_main_establishment: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagingResultsInfo:
    current_page: Optional[int] = None
    max_results_per_page: Optional[int] = None
    number_of_pages: Optional[int] = None
    number_of_results: Optional[int] = None
    maximum_results: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyLookupSearchResults:
    results: Optional[List[CompanyLookupEntry]] = None
    paging_results_info: Optional[PagingResultsInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCompaniesLookup:
    chamber_nr: Optional[str] = None
    trade_name: Optional[str] = None
    city: Optional[str] = None

Python GetCompaniesLookup 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 HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyLookupSearchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.CompanyLookup.DTO">
  <PagingResultsInfo>
    <CurrentPage>0</CurrentPage>
    <MaxResultsPerPage>0</MaxResultsPerPage>
    <MaximumResults>0</MaximumResults>
    <NumberOfPages>0</NumberOfPages>
    <NumberOfResults>0</NumberOfResults>
  </PagingResultsInfo>
  <Results />
</CompanyLookupSearchResults>