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}
"use strict";
export class CompanyLookupDetails {
    /** @param {{ChamberNr?:string,ChamberEstablishmentNumber?:string,CompanyLegalName?:string,CompanyTradeName?:string,ChamberCity?:string,ChamberFoundingDate?:string,EstablishmentStreet?:string,EstablishmentHouseNr?:string,EstablishmentHouseNrAddition?:string,EstablishmentPostalCode?:string,EstablishmentCity?:string,EstablishmentCountryTLA?:string,CorrespondenceStreet?:string,CorrespondenceHouseNr?:string,CorrespondenceHouseNrAddition?:string,CorrespondencePostalCode?:string,CorrespondenceCity?:string,CorrespondenceCountryTLA?:string,Website?:string,Telephone?:string,Mobile?:string,EMail?:string,DebtorInPossession?:boolean,Bankrupt?:boolean,ExtraFields?:{ [index:string]: Object; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChamberNr;
    /** @type {string} */
    ChamberEstablishmentNumber;
    /** @type {string} */
    CompanyLegalName;
    /** @type {string} */
    CompanyTradeName;
    /** @type {string} */
    ChamberCity;
    /** @type {?string} */
    ChamberFoundingDate;
    /** @type {string} */
    EstablishmentStreet;
    /** @type {string} */
    EstablishmentHouseNr;
    /** @type {string} */
    EstablishmentHouseNrAddition;
    /** @type {string} */
    EstablishmentPostalCode;
    /** @type {string} */
    EstablishmentCity;
    /** @type {string} */
    EstablishmentCountryTLA;
    /** @type {string} */
    CorrespondenceStreet;
    /** @type {string} */
    CorrespondenceHouseNr;
    /** @type {string} */
    CorrespondenceHouseNrAddition;
    /** @type {string} */
    CorrespondencePostalCode;
    /** @type {string} */
    CorrespondenceCity;
    /** @type {string} */
    CorrespondenceCountryTLA;
    /** @type {string} */
    Website;
    /** @type {string} */
    Telephone;
    /** @type {string} */
    Mobile;
    /** @type {string} */
    EMail;
    /** @type {boolean} */
    DebtorInPossession;
    /** @type {boolean} */
    Bankrupt;
    /** @type {{ [index:string]: Object; }} */
    ExtraFields;
}
export class GetCompanyLookupDetails {
    /** @param {{ChamberNr?:string,ChamberEstablishmentNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChamberNr;
    /** @type {string} */
    ChamberEstablishmentNumber;
}

JavaScript 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: test-dogw.klokgroep.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>
  <CorrespondenceHouseNr>String</CorrespondenceHouseNr>
  <CorrespondenceHouseNrAddition>String</CorrespondenceHouseNrAddition>
  <CorrespondencePostalCode>String</CorrespondencePostalCode>
  <CorrespondenceStreet>String</CorrespondenceStreet>
  <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>