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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ChamberNr":"String","ChamberEstablishmentNumber":"String","CompanyLegalName":"String","CompanyTradeName":"String","ChamberCity":"String","ChamberFoundingDate":"0001-01-01T00:00:00.0000000","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":false,"Bankrupt":false,"ExtraFields":{"String":{}}}