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 .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>