DigiOffice Gateway Web Services

GetCompaniesLookup

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