DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup
"use strict";
export class CompanyLookupEntry {
    /** @param {{ChamberNr?:string,ChamberEstablishmentNumber?:string,LegalName?:string,TradeName?:string,MatchType?:string,EstablishmentCity?:string,EstablishmentStreet?:string,CorrespondenceCity?:string,CorrespondenceStreet?:string,IndicationMainEstablishment?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChamberNr;
    /** @type {string} */
    ChamberEstablishmentNumber;
    /** @type {string} */
    LegalName;
    /** @type {string} */
    TradeName;
    /** @type {string} */
    MatchType;
    /** @type {string} */
    EstablishmentCity;
    /** @type {string} */
    EstablishmentStreet;
    /** @type {string} */
    CorrespondenceCity;
    /** @type {string} */
    CorrespondenceStreet;
    /** @type {?boolean} */
    IndicationMainEstablishment;
}
export class PagingResultsInfo {
    /** @param {{CurrentPage?:number,MaxResultsPerPage?:number,NumberOfPages?:number,NumberOfResults?:number,MaximumResults?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CurrentPage;
    /** @type {number} */
    MaxResultsPerPage;
    /** @type {number} */
    NumberOfPages;
    /** @type {number} */
    NumberOfResults;
    /** @type {number} */
    MaximumResults;
}
export class CompanyLookupSearchResults {
    /** @param {{Results?:CompanyLookupEntry[],PagingResultsInfo?:PagingResultsInfo}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CompanyLookupEntry[]} */
    Results;
    /** @type {PagingResultsInfo} */
    PagingResultsInfo;
}
export class GetCompaniesLookup {
    /** @param {{ChamberNr?:string,TradeName?:string,City?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChamberNr;
    /** @type {string} */
    TradeName;
    /** @type {string} */
    City;
}

JavaScript GetCompaniesLookup DTOs

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

HTTP + OTHER

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: test-dogw.klokgroep.nl 
Accept: text/jsonl

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

{"Results":[],"PagingResultsInfo":{"CurrentPage":0,"MaxResultsPerPage":0,"NumberOfPages":0,"NumberOfResults":0,"MaximumResults":0}}