DigiOffice Gateway Web Services

GetCompaniesLookup

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

**GetCompaniesLookup** Parameters:
Name	Parameter	Data Type	Required
ChamberNr	query	string	No
TradeName	query	string	No
City	query	string	No

**CompanyLookupSearchResults** Parameters:
Name	Parameter	Data Type	Required	Description
Results	form	List<CompanyLookupEntry>	No
PagingResultsInfo	form	PagingResultsInfo	No

**CompanyLookupEntry** Parameters:
Name	Parameter	Data Type	Required
ChamberNr	form	string	No
ChamberEstablishmentNumber	form	string	No
LegalName	form	string	No
TradeName	form	string	No
MatchType	form	string	No
EstablishmentCity	form	string	No
EstablishmentStreet	form	string	No
CorrespondenceCity	form	string	No
CorrespondenceStreet	form	string	No
IndicationMainEstablishment	form	bool?	No

**PagingResultsInfo** Parameters:
Name	Parameter	Data Type	Required
CurrentPage	form	int	No
MaxResultsPerPage	form	int	No
NumberOfPages	form	int	No
NumberOfResults	form	int	No
MaximumResults	form	int	No

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>