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 java.io.InputStream
import net.servicestack.client.*


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

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

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

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

Kotlin GetCompaniesLookup DTOs

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

HTTP + JSV

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: dogw.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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