DigiOffice Gateway Web Services

<back to all web services

GetCompanyLookupDetails

Requires Authentication
The following routes are available for this service:
GET/api/companies/lookup/{ChamberNr}
namespace IDB.CompanyLookup.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CompanyLookupDetails() = 
        member val ChamberNr:String = null with get,set
        member val ChamberEstablishmentNumber:String = null with get,set
        member val CompanyLegalName:String = null with get,set
        member val CompanyTradeName:String = null with get,set
        member val ChamberCity:String = null with get,set
        member val ChamberFoundingDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EstablishmentStreet:String = null with get,set
        member val EstablishmentHouseNr:String = null with get,set
        member val EstablishmentHouseNrAddition:String = null with get,set
        member val EstablishmentPostalCode:String = null with get,set
        member val EstablishmentCity:String = null with get,set
        member val EstablishmentCountryTLA:String = null with get,set
        member val CorrespondencePOBox:String = null with get,set
        member val CorrespondencePostalCode:String = null with get,set
        member val CorrespondenceCity:String = null with get,set
        member val CorrespondenceCountryTLA:String = null with get,set
        member val Website:String = null with get,set
        member val Telephone:String = null with get,set
        member val Mobile:String = null with get,set
        member val EMail:String = null with get,set
        member val DebtorInPossession:Boolean = new Boolean() with get,set
        member val Bankrupt:Boolean = new Boolean() with get,set
        member val ExtraFields:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type GetCompanyLookupDetails() = 
        member val ChamberNr:String = null with get,set
        member val ChamberEstablishmentNumber:String = null with get,set

F# GetCompanyLookupDetails 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/{ChamberNr} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ChamberNr":"String","ChamberEstablishmentNumber":"String","CompanyLegalName":"String","CompanyTradeName":"String","ChamberCity":"String","ChamberFoundingDate":"0001-01-01T00:00:00.0000000","EstablishmentStreet":"String","EstablishmentHouseNr":"String","EstablishmentHouseNrAddition":"String","EstablishmentPostalCode":"String","EstablishmentCity":"String","EstablishmentCountryTLA":"String","CorrespondencePOBox":"String","CorrespondencePostalCode":"String","CorrespondenceCity":"String","CorrespondenceCountryTLA":"String","Website":"String","Telephone":"String","Mobile":"String","EMail":"String","DebtorInPossession":false,"Bankrupt":false,"ExtraFields":{"String":{}}}