DigiOffice Gateway Web Services

GetCompaniesLookup

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetCompaniesLookup
{
    var ChamberNr:String? = null
    var TradeName:String? = null
    var City:String? = null
}

open class CompanyLookupSearchResults
{
    var Results:ArrayList<CompanyLookupEntry> = ArrayList<CompanyLookupEntry>()
    var PagingResultsInfo:PagingResultsInfo? = null
}

open class CompanyLookupEntry
{
    var ChamberNr:String? = null
    var ChamberEstablishmentNumber:String? = null
    var LegalName:String? = null
    var TradeName:String? = null
    var MatchType:String? = null
    var EstablishmentCity:String? = null
    var EstablishmentStreet:String? = null
    var CorrespondenceCity:String? = null
    var CorrespondenceStreet:String? = null
    var IndicationMainEstablishment:Boolean? = null
}

open class PagingResultsInfo
{
    var CurrentPage:Int? = null
    var MaxResultsPerPage:Int? = null
    var NumberOfPages:Int? = null
    var NumberOfResults:Int? = null
    var MaximumResults:Int? = null
}

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