DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup
GetCompaniesLookup Parameters:
NameParameterData TypeRequiredDescription
ChamberNrquerystringNo
TradeNamequerystringNo
CityquerystringNo
CompanyLookupSearchResults Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<CompanyLookupEntry>No
PagingResultsInfoformPagingResultsInfoNo
CompanyLookupEntry Parameters:
NameParameterData TypeRequiredDescription
ChamberNrformstringNo
ChamberEstablishmentNumberformstringNo
LegalNameformstringNo
TradeNameformstringNo
MatchTypeformstringNo
EstablishmentCityformstringNo
EstablishmentStreetformstringNo
CorrespondenceCityformstringNo
CorrespondenceStreetformstringNo
IndicationMainEstablishmentformbool?No
PagingResultsInfo Parameters:
NameParameterData TypeRequiredDescription
CurrentPageformintNo
MaxResultsPerPageformintNo
NumberOfPagesformintNo
NumberOfResultsformintNo
MaximumResultsformintNo

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 HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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