DigiOffice Gateway Web Services

GetEntitySummary

Get the summary of an entity.

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

import 'package:servicestack/servicestack.dart';

class EntitySummaryResponse implements IConvertible
{
    String? Summary;

    EntitySummaryResponse({this.Summary});
    EntitySummaryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Get the summary of an entity.
*/
// @Api(Description="Get the summary of an entity.")
class GetEntitySummary 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;

    GetEntitySummary({this.EntityID,this.EntityName});
    GetEntitySummary.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() => "GetEntitySummary";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'EntitySummaryResponse': TypeInfo(TypeOf.Class, create:() => EntitySummaryResponse()),
    'GetEntitySummary': TypeInfo(TypeOf.Class, create:() => GetEntitySummary()),
});

Dart GetEntitySummary 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/entities/{EntityName}/{EntityID}/summary HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EntitySummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.General">
  <Summary>String</Summary>
</EntitySummaryResponse>