DigiOffice Gateway Web Services

<back to all web services

GetCompaniesLookup

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

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

    [<AllowNullLiteral>]
    type CompanyLookupEntry() = 
        member val ChamberNr:String = null with get,set
        member val ChamberEstablishmentNumber:String = null with get,set
        member val LegalName:String = null with get,set
        member val TradeName:String = null with get,set
        member val MatchType:String = null with get,set
        member val EstablishmentCity:String = null with get,set
        member val EstablishmentStreet:String = null with get,set
        member val CorrespondenceCity:String = null with get,set
        member val CorrespondenceStreet:String = null with get,set
        member val IndicationMainEstablishment:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type PagingResultsInfo() = 
        member val CurrentPage:Int32 = new Int32() with get,set
        member val MaxResultsPerPage:Int32 = new Int32() with get,set
        member val NumberOfPages:Int32 = new Int32() with get,set
        member val NumberOfResults:Int32 = new Int32() with get,set
        member val MaximumResults:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CompanyLookupSearchResults() = 
        member val Results:ResizeArray<CompanyLookupEntry> = new ResizeArray<CompanyLookupEntry>() with get,set
        member val PagingResultsInfo:PagingResultsInfo = null with get,set

    [<AllowNullLiteral>]
    type GetCompaniesLookup() = 
        member val ChamberNr:String = null with get,set
        member val TradeName:String = null with get,set
        member val City:String = null with get,set

F# GetCompaniesLookup DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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