DigiOffice Gateway Web Services

GetEntityIdentifier

Returns the identifier information of an entity.

The following routes are available for this service:
GET	/api/entities/{EntityName}/{EntityID}

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CommonEntityIdentifier implements IConvertible
{
    String? ID;
    String? DisplayName;
    String? EntityName;

    CommonEntityIdentifier({this.ID,this.DisplayName,this.EntityName});
    CommonEntityIdentifier.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        DisplayName = json['DisplayName'];
        EntityName = json['EntityName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'DisplayName': DisplayName,
        'EntityName': EntityName
    };

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

/**
* Returns the identifier information of an entity.
*/
// @Api(Description="Returns the identifier information of an entity.")
class GetEntityIdentifier implements IConvertible
{
    /**
    * ID of the entity
    */
    // @ApiMember(Description="ID of the entity", IsRequired=true)
    String? EntityID;

    /**
    * Name of the entity
    */
    // @ApiMember(Description="Name of the entity", IsRequired=true)
    String? EntityName;

    GetEntityIdentifier({this.EntityID,this.EntityName});
    GetEntityIdentifier.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EntityID = json['EntityID'];
        EntityName = json['EntityName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EntityID': EntityID,
        'EntityName': EntityName
    };

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

TypeContext _ctx = TypeContext(library: 'doapigw.baasbv.nl', types: <String, TypeInfo> {
    'CommonEntityIdentifier': TypeInfo(TypeOf.Class, create:() => CommonEntityIdentifier()),
    'GetEntityIdentifier': TypeInfo(TypeOf.Class, create:() => GetEntityIdentifier()),
});

Dart GetEntityIdentifier 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/entities/{EntityName}/{EntityID} HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":"String","DisplayName":"String","EntityName":"String"}