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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntitySummaryResponse:
    summary: Optional[str] = None


# @Api(Description="Get the summary of an entity.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEntitySummary:
    """
    Get the summary of an entity.
    """

    # @ApiMember(Description="ID of the entity", IsRequired=true)
    entity_i_d: Optional[str] = None
    """
    ID of the entity
    """


    # @ApiMember(Description="Name of the entity", IsRequired=true)
    entity_name: Optional[str] = None
    """
    Name of the entity
    """

Python 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>