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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.General.Operations
Imports IDB.API.DTO.General

Namespace Global

    Namespace IDB.API.DTO.General

        Public Partial Class EntitySummaryResponse
            Public Overridable Property Summary As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.General.Operations

        '''<Summary>
        '''Get the summary of an entity.
        '''</Summary>
        <Api(Description:="Get the summary of an entity.")>
        Public Partial Class GetEntitySummary
            '''<Summary>
            '''ID of the entity
            '''</Summary>
            <ApiMember(Description:="ID of the entity", IsRequired:=true)>
            Public Overridable Property EntityID As String

            '''<Summary>
            '''Name of the entity
            '''</Summary>
            <ApiMember(Description:="Name of the entity", IsRequired:=true)>
            Public Overridable Property EntityName As String
        End Class
    End Namespace
End Namespace

VB.NET GetEntitySummary 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}/summary HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv

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

{"Summary":"String"}