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


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 .csv suffix or ?format=csv

HTTP + CSV

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

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