DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetCompaniesLookup
    {
        public String ChamberNr = null;
        public String TradeName = null;
        public String City = null;
        
        public String getChamberNr() { return ChamberNr; }
        public GetCompaniesLookup setChamberNr(String value) { this.ChamberNr = value; return this; }
        public String getTradeName() { return TradeName; }
        public GetCompaniesLookup setTradeName(String value) { this.TradeName = value; return this; }
        public String getCity() { return City; }
        public GetCompaniesLookup setCity(String value) { this.City = value; return this; }
    }

    public static class CompanyLookupSearchResults
    {
        public ArrayList<CompanyLookupEntry> Results = null;
        public PagingResultsInfo PagingResultsInfo = null;
        
        public ArrayList<CompanyLookupEntry> getResults() { return Results; }
        public CompanyLookupSearchResults setResults(ArrayList<CompanyLookupEntry> value) { this.Results = value; return this; }
        public PagingResultsInfo getPagingResultsInfo() { return PagingResultsInfo; }
        public CompanyLookupSearchResults setPagingResultsInfo(PagingResultsInfo value) { this.PagingResultsInfo = value; return this; }
    }

    public static class CompanyLookupEntry
    {
        public String ChamberNr = null;
        public String ChamberEstablishmentNumber = null;
        public String LegalName = null;
        public String TradeName = null;
        public String MatchType = null;
        public String EstablishmentCity = null;
        public String EstablishmentStreet = null;
        public String CorrespondenceCity = null;
        public String CorrespondenceStreet = null;
        public Boolean IndicationMainEstablishment = null;
        
        public String getChamberNr() { return ChamberNr; }
        public CompanyLookupEntry setChamberNr(String value) { this.ChamberNr = value; return this; }
        public String getChamberEstablishmentNumber() { return ChamberEstablishmentNumber; }
        public CompanyLookupEntry setChamberEstablishmentNumber(String value) { this.ChamberEstablishmentNumber = value; return this; }
        public String getLegalName() { return LegalName; }
        public CompanyLookupEntry setLegalName(String value) { this.LegalName = value; return this; }
        public String getTradeName() { return TradeName; }
        public CompanyLookupEntry setTradeName(String value) { this.TradeName = value; return this; }
        public String getMatchType() { return MatchType; }
        public CompanyLookupEntry setMatchType(String value) { this.MatchType = value; return this; }
        public String getEstablishmentCity() { return EstablishmentCity; }
        public CompanyLookupEntry setEstablishmentCity(String value) { this.EstablishmentCity = value; return this; }
        public String getEstablishmentStreet() { return EstablishmentStreet; }
        public CompanyLookupEntry setEstablishmentStreet(String value) { this.EstablishmentStreet = value; return this; }
        public String getCorrespondenceCity() { return CorrespondenceCity; }
        public CompanyLookupEntry setCorrespondenceCity(String value) { this.CorrespondenceCity = value; return this; }
        public String getCorrespondenceStreet() { return CorrespondenceStreet; }
        public CompanyLookupEntry setCorrespondenceStreet(String value) { this.CorrespondenceStreet = value; return this; }
        public Boolean isIndicationMainEstablishment() { return IndicationMainEstablishment; }
        public CompanyLookupEntry setIndicationMainEstablishment(Boolean value) { this.IndicationMainEstablishment = value; return this; }
    }

    public static class PagingResultsInfo
    {
        public Integer CurrentPage = null;
        public Integer MaxResultsPerPage = null;
        public Integer NumberOfPages = null;
        public Integer NumberOfResults = null;
        public Integer MaximumResults = null;
        
        public Integer getCurrentPage() { return CurrentPage; }
        public PagingResultsInfo setCurrentPage(Integer value) { this.CurrentPage = value; return this; }
        public Integer getMaxResultsPerPage() { return MaxResultsPerPage; }
        public PagingResultsInfo setMaxResultsPerPage(Integer value) { this.MaxResultsPerPage = value; return this; }
        public Integer getNumberOfPages() { return NumberOfPages; }
        public PagingResultsInfo setNumberOfPages(Integer value) { this.NumberOfPages = value; return this; }
        public Integer getNumberOfResults() { return NumberOfResults; }
        public PagingResultsInfo setNumberOfResults(Integer value) { this.NumberOfResults = value; return this; }
        public Integer getMaximumResults() { return MaximumResults; }
        public PagingResultsInfo setMaximumResults(Integer value) { this.MaximumResults = value; return this; }
    }

}

Java GetCompaniesLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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