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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CompanyLookupEntry implements IConvertible
{
    String? ChamberNr;
    String? ChamberEstablishmentNumber;
    String? LegalName;
    String? TradeName;
    String? MatchType;
    String? EstablishmentCity;
    String? EstablishmentStreet;
    String? CorrespondenceCity;
    String? CorrespondenceStreet;
    bool? IndicationMainEstablishment;

    CompanyLookupEntry({this.ChamberNr,this.ChamberEstablishmentNumber,this.LegalName,this.TradeName,this.MatchType,this.EstablishmentCity,this.EstablishmentStreet,this.CorrespondenceCity,this.CorrespondenceStreet,this.IndicationMainEstablishment});
    CompanyLookupEntry.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChamberNr = json['ChamberNr'];
        ChamberEstablishmentNumber = json['ChamberEstablishmentNumber'];
        LegalName = json['LegalName'];
        TradeName = json['TradeName'];
        MatchType = json['MatchType'];
        EstablishmentCity = json['EstablishmentCity'];
        EstablishmentStreet = json['EstablishmentStreet'];
        CorrespondenceCity = json['CorrespondenceCity'];
        CorrespondenceStreet = json['CorrespondenceStreet'];
        IndicationMainEstablishment = json['IndicationMainEstablishment'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChamberNr': ChamberNr,
        'ChamberEstablishmentNumber': ChamberEstablishmentNumber,
        'LegalName': LegalName,
        'TradeName': TradeName,
        'MatchType': MatchType,
        'EstablishmentCity': EstablishmentCity,
        'EstablishmentStreet': EstablishmentStreet,
        'CorrespondenceCity': CorrespondenceCity,
        'CorrespondenceStreet': CorrespondenceStreet,
        'IndicationMainEstablishment': IndicationMainEstablishment
    };

    getTypeName() => "CompanyLookupEntry";
    TypeContext? context = _ctx;
}

class PagingResultsInfo implements IConvertible
{
    int? CurrentPage;
    int? MaxResultsPerPage;
    int? NumberOfPages;
    int? NumberOfResults;
    int? MaximumResults;

    PagingResultsInfo({this.CurrentPage,this.MaxResultsPerPage,this.NumberOfPages,this.NumberOfResults,this.MaximumResults});
    PagingResultsInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CurrentPage = json['CurrentPage'];
        MaxResultsPerPage = json['MaxResultsPerPage'];
        NumberOfPages = json['NumberOfPages'];
        NumberOfResults = json['NumberOfResults'];
        MaximumResults = json['MaximumResults'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CurrentPage': CurrentPage,
        'MaxResultsPerPage': MaxResultsPerPage,
        'NumberOfPages': NumberOfPages,
        'NumberOfResults': NumberOfResults,
        'MaximumResults': MaximumResults
    };

    getTypeName() => "PagingResultsInfo";
    TypeContext? context = _ctx;
}

class CompanyLookupSearchResults implements IConvertible
{
    List<CompanyLookupEntry>? Results;
    PagingResultsInfo? PagingResultsInfo;

    CompanyLookupSearchResults({this.Results,this.PagingResultsInfo});
    CompanyLookupSearchResults.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Results = JsonConverters.fromJson(json['Results'],'List<CompanyLookupEntry>',context!);
        PagingResultsInfo = JsonConverters.fromJson(json['PagingResultsInfo'],'PagingResultsInfo',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Results': JsonConverters.toJson(Results,'List<CompanyLookupEntry>',context!),
        'PagingResultsInfo': JsonConverters.toJson(PagingResultsInfo,'PagingResultsInfo',context!)
    };

    getTypeName() => "CompanyLookupSearchResults";
    TypeContext? context = _ctx;
}

class GetCompaniesLookup implements IConvertible
{
    String? ChamberNr;
    String? TradeName;
    String? City;

    GetCompaniesLookup({this.ChamberNr,this.TradeName,this.City});
    GetCompaniesLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChamberNr = json['ChamberNr'];
        TradeName = json['TradeName'];
        City = json['City'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChamberNr': ChamberNr,
        'TradeName': TradeName,
        'City': City
    };

    getTypeName() => "GetCompaniesLookup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'CompanyLookupEntry': TypeInfo(TypeOf.Class, create:() => CompanyLookupEntry()),
    'PagingResultsInfo': TypeInfo(TypeOf.Class, create:() => PagingResultsInfo()),
    'CompanyLookupSearchResults': TypeInfo(TypeOf.Class, create:() => CompanyLookupSearchResults()),
    'List<CompanyLookupEntry>': TypeInfo(TypeOf.Class, create:() => <CompanyLookupEntry>[]),
    'GetCompaniesLookup': TypeInfo(TypeOf.Class, create:() => GetCompaniesLookup()),
});

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