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}
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 CompanyLookupDetails:
    chamber_nr: Optional[str] = None
    chamber_establishment_number: Optional[str] = None
    company_legal_name: Optional[str] = None
    company_trade_name: Optional[str] = None
    chamber_city: Optional[str] = None
    chamber_founding_date: Optional[datetime.datetime] = None
    establishment_street: Optional[str] = None
    establishment_house_nr: Optional[str] = None
    establishment_house_nr_addition: Optional[str] = None
    establishment_postal_code: Optional[str] = None
    establishment_city: Optional[str] = None
    establishment_country_t_l_a: Optional[str] = None
    correspondence_p_o_box: Optional[str] = None
    correspondence_postal_code: Optional[str] = None
    correspondence_city: Optional[str] = None
    correspondence_country_t_l_a: Optional[str] = None
    website: Optional[str] = None
    telephone: Optional[str] = None
    mobile: Optional[str] = None
    e_mail: Optional[str] = None
    debtor_in_possession: Optional[bool] = None
    bankrupt: Optional[bool] = None
    extra_fields: Optional[Dict[str, Object]] = None


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

Python GetCompanyLookupDetails DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ChamberNr: String,
	ChamberEstablishmentNumber: String,
	CompanyLegalName: String,
	CompanyTradeName: String,
	ChamberCity: String,
	ChamberFoundingDate: 0001-01-01,
	EstablishmentStreet: String,
	EstablishmentHouseNr: String,
	EstablishmentHouseNrAddition: String,
	EstablishmentPostalCode: String,
	EstablishmentCity: String,
	EstablishmentCountryTLA: String,
	CorrespondencePOBox: String,
	CorrespondencePostalCode: String,
	CorrespondenceCity: String,
	CorrespondenceCountryTLA: String,
	Website: String,
	Telephone: String,
	Mobile: String,
	EMail: String,
	DebtorInPossession: False,
	Bankrupt: False,
	ExtraFields: 
	{
		String: {}
	}
}