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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Results":[],"PagingResultsInfo":{"CurrentPage":0,"MaxResultsPerPage":0,"NumberOfPages":0,"NumberOfResults":0,"MaximumResults":0}}