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 Foundation
import ServiceStack

public class GetCompaniesLookup : Codable
{
    public var chamberNr:String?
    public var tradeName:String?
    public var city:String?

    required public init(){}
}

public class CompanyLookupSearchResults : Codable
{
    public var results:[CompanyLookupEntry] = []
    public var pagingResultsInfo:PagingResultsInfo?

    required public init(){}
}

public class CompanyLookupEntry : Codable
{
    public var chamberNr:String?
    public var chamberEstablishmentNumber:String?
    public var legalName:String?
    public var tradeName:String?
    public var matchType:String?
    public var establishmentCity:String?
    public var establishmentStreet:String?
    public var correspondenceCity:String?
    public var correspondenceStreet:String?
    public var indicationMainEstablishment:Bool?

    required public init(){}
}

public class PagingResultsInfo : Codable
{
    public var currentPage:Int?
    public var maxResultsPerPage:Int?
    public var numberOfPages:Int?
    public var numberOfResults:Int?
    public var maximumResults:Int?

    required public init(){}
}


Swift 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}}