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}

export class CompanyLookupDetails
{
    public ChamberNr?: string;
    public ChamberEstablishmentNumber?: string;
    public CompanyLegalName?: string;
    public CompanyTradeName?: string;
    public ChamberCity?: string;
    public ChamberFoundingDate?: string;
    public EstablishmentStreet?: string;
    public EstablishmentHouseNr?: string;
    public EstablishmentHouseNrAddition?: string;
    public EstablishmentPostalCode?: string;
    public EstablishmentCity?: string;
    public EstablishmentCountryTLA?: string;
    public CorrespondencePOBox?: string;
    public CorrespondencePostalCode?: string;
    public CorrespondenceCity?: string;
    public CorrespondenceCountryTLA?: string;
    public Website?: string;
    public Telephone?: string;
    public Mobile?: string;
    public EMail?: string;
    public DebtorInPossession?: boolean;
    public Bankrupt?: boolean;
    public ExtraFields?: { [index: string]: Object; };

    public constructor(init?: Partial<CompanyLookupDetails>) { (Object as any).assign(this, init); }
}

export class GetCompanyLookupDetails
{
    public ChamberNr?: string;
    public ChamberEstablishmentNumber?: string;

    public constructor(init?: Partial<GetCompanyLookupDetails>) { (Object as any).assign(this, init); }
}

TypeScript 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: digiofficeapigateway.deltares.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","CorrespondencePOBox":"String","CorrespondencePostalCode":"String","CorrespondenceCity":"String","CorrespondenceCountryTLA":"String","Website":"String","Telephone":"String","Mobile":"String","EMail":"String","DebtorInPossession":false,"Bankrupt":false,"ExtraFields":{"String":{}}}