DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.CompanyLookup.DTO.Operations;
using IDB.CompanyLookup.DTO;

namespace IDB.CompanyLookup.DTO
{
    public partial class CompanyLookupEntry
    {
        public virtual string ChamberNr { get; set; }
        public virtual string ChamberEstablishmentNumber { get; set; }
        public virtual string LegalName { get; set; }
        public virtual string TradeName { get; set; }
        public virtual string MatchType { get; set; }
        public virtual string EstablishmentCity { get; set; }
        public virtual string EstablishmentStreet { get; set; }
        public virtual string CorrespondenceCity { get; set; }
        public virtual string CorrespondenceStreet { get; set; }
        public virtual bool? IndicationMainEstablishment { get; set; }
    }

    public partial class CompanyLookupSearchResults
    {
        public CompanyLookupSearchResults()
        {
            Results = new List<CompanyLookupEntry>{};
        }

        public virtual List<CompanyLookupEntry> Results { get; set; }
        public virtual PagingResultsInfo PagingResultsInfo { get; set; }
    }

    public partial class PagingResultsInfo
    {
        public virtual int CurrentPage { get; set; }
        public virtual int MaxResultsPerPage { get; set; }
        public virtual int NumberOfPages { get; set; }
        public virtual int NumberOfResults { get; set; }
        public virtual int MaximumResults { get; set; }
    }

}

namespace IDB.CompanyLookup.DTO.Operations
{
    public partial class GetCompaniesLookup
    {
        public virtual string ChamberNr { get; set; }
        public virtual string TradeName { get; set; }
        public virtual string City { get; set; }
    }

}

C# 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>