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 'package:servicestack/servicestack.dart';

class CompanyLookupDetails implements IConvertible
{
    String? ChamberNr;
    String? ChamberEstablishmentNumber;
    String? CompanyLegalName;
    String? CompanyTradeName;
    String? ChamberCity;
    DateTime? ChamberFoundingDate;
    String? 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;
    bool? DebtorInPossession;
    bool? Bankrupt;
    Map<String,dynamic?>? ExtraFields;

    CompanyLookupDetails({this.ChamberNr,this.ChamberEstablishmentNumber,this.CompanyLegalName,this.CompanyTradeName,this.ChamberCity,this.ChamberFoundingDate,this.EstablishmentStreet,this.EstablishmentHouseNr,this.EstablishmentHouseNrAddition,this.EstablishmentPostalCode,this.EstablishmentCity,this.EstablishmentCountryTLA,this.CorrespondencePOBox,this.CorrespondencePostalCode,this.CorrespondenceCity,this.CorrespondenceCountryTLA,this.Website,this.Telephone,this.Mobile,this.EMail,this.DebtorInPossession,this.Bankrupt,this.ExtraFields});
    CompanyLookupDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChamberNr = json['ChamberNr'];
        ChamberEstablishmentNumber = json['ChamberEstablishmentNumber'];
        CompanyLegalName = json['CompanyLegalName'];
        CompanyTradeName = json['CompanyTradeName'];
        ChamberCity = json['ChamberCity'];
        ChamberFoundingDate = JsonConverters.fromJson(json['ChamberFoundingDate'],'DateTime',context!);
        EstablishmentStreet = json['EstablishmentStreet'];
        EstablishmentHouseNr = json['EstablishmentHouseNr'];
        EstablishmentHouseNrAddition = json['EstablishmentHouseNrAddition'];
        EstablishmentPostalCode = json['EstablishmentPostalCode'];
        EstablishmentCity = json['EstablishmentCity'];
        EstablishmentCountryTLA = json['EstablishmentCountryTLA'];
        CorrespondencePOBox = json['CorrespondencePOBox'];
        CorrespondencePostalCode = json['CorrespondencePostalCode'];
        CorrespondenceCity = json['CorrespondenceCity'];
        CorrespondenceCountryTLA = json['CorrespondenceCountryTLA'];
        Website = json['Website'];
        Telephone = json['Telephone'];
        Mobile = json['Mobile'];
        EMail = json['EMail'];
        DebtorInPossession = json['DebtorInPossession'];
        Bankrupt = json['Bankrupt'];
        ExtraFields = JsonConverters.fromJson(json['ExtraFields'],'Map<String,dynamic?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChamberNr': ChamberNr,
        'ChamberEstablishmentNumber': ChamberEstablishmentNumber,
        'CompanyLegalName': CompanyLegalName,
        'CompanyTradeName': CompanyTradeName,
        'ChamberCity': ChamberCity,
        'ChamberFoundingDate': JsonConverters.toJson(ChamberFoundingDate,'DateTime',context!),
        'EstablishmentStreet': EstablishmentStreet,
        'EstablishmentHouseNr': EstablishmentHouseNr,
        'EstablishmentHouseNrAddition': EstablishmentHouseNrAddition,
        'EstablishmentPostalCode': EstablishmentPostalCode,
        'EstablishmentCity': EstablishmentCity,
        'EstablishmentCountryTLA': EstablishmentCountryTLA,
        'CorrespondencePOBox': CorrespondencePOBox,
        'CorrespondencePostalCode': CorrespondencePostalCode,
        'CorrespondenceCity': CorrespondenceCity,
        'CorrespondenceCountryTLA': CorrespondenceCountryTLA,
        'Website': Website,
        'Telephone': Telephone,
        'Mobile': Mobile,
        'EMail': EMail,
        'DebtorInPossession': DebtorInPossession,
        'Bankrupt': Bankrupt,
        'ExtraFields': JsonConverters.toJson(ExtraFields,'Map<String,dynamic?>',context!)
    };

    getTypeName() => "CompanyLookupDetails";
    TypeContext? context = _ctx;
}

class GetCompanyLookupDetails implements IConvertible
{
    String? ChamberNr;
    String? ChamberEstablishmentNumber;

    GetCompanyLookupDetails({this.ChamberNr,this.ChamberEstablishmentNumber});
    GetCompanyLookupDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChamberNr = json['ChamberNr'];
        ChamberEstablishmentNumber = json['ChamberEstablishmentNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChamberNr': ChamberNr,
        'ChamberEstablishmentNumber': ChamberEstablishmentNumber
    };

    getTypeName() => "GetCompanyLookupDetails";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'CompanyLookupDetails': TypeInfo(TypeOf.Class, create:() => CompanyLookupDetails()),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
    'GetCompanyLookupDetails': TypeInfo(TypeOf.Class, create:() => GetCompanyLookupDetails()),
});

Dart 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>