DigiOffice Gateway Web Services

<back to all web services

GetEntitySummary

Get the summary of an entity.

Requires Authentication
The following routes are available for this service:
GET/api/entities/{EntityName}/{EntityID}/summary
namespace IDB.API.DTO.General

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EntitySummaryResponse() = 
        member val Summary:String = null with get,set

    ///<summary>
    ///Get the summary of an entity.
    ///</summary>
    [<Api(Description="Get the summary of an entity.")>]
    [<AllowNullLiteral>]
    type GetEntitySummary() = 
        ///<summary>
        ///ID of the entity
        ///</summary>
        [<ApiMember(Description="ID of the entity", IsRequired=true)>]
        member val EntityID:String = null with get,set

        ///<summary>
        ///Name of the entity
        ///</summary>
        [<ApiMember(Description="Name of the entity", IsRequired=true)>]
        member val EntityName:String = null with get,set

F# 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>