DigiOffice Gateway Web Services

GetCompaniesLookup

The following routes are available for this service:
GET	/api/companies/lookup


export class CompanyLookupEntry
{
    public ChamberNr?: string;
    public ChamberEstablishmentNumber?: string;
    public LegalName?: string;
    public TradeName?: string;
    public MatchType?: string;
    public EstablishmentCity?: string;
    public EstablishmentStreet?: string;
    public CorrespondenceCity?: string;
    public CorrespondenceStreet?: string;
    public IndicationMainEstablishment?: boolean;

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

export class PagingResultsInfo
{
    public CurrentPage?: number;
    public MaxResultsPerPage?: number;
    public NumberOfPages?: number;
    public NumberOfResults?: number;
    public MaximumResults?: number;

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

export class CompanyLookupSearchResults
{
    public Results?: CompanyLookupEntry[];
    public PagingResultsInfo?: PagingResultsInfo;

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

export class GetCompaniesLookup
{
    public ChamberNr?: string;
    public TradeName?: string;
    public City?: string;

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

TypeScript GetCompaniesLookup 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 HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyLookupSearchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.CompanyLookup.DTO">
  <PagingResultsInfo>
    <CurrentPage>0</CurrentPage>
    <MaxResultsPerPage>0</MaxResultsPerPage>
    <MaximumResults>0</MaximumResults>
    <NumberOfPages>0</NumberOfPages>
    <NumberOfResults>0</NumberOfResults>
  </PagingResultsInfo>
  <Results />
</CompanyLookupSearchResults>