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

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

namespace IDB.API.DTO.General
{
    public partial class EntitySummaryResponse
    {
        public virtual string Summary { get; set; }
    }

}

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 virtual string EntityID { get; set; }

        ///<summary>
        ///Name of the entity
        ///</summary>
        [ApiMember(Description="Name of the entity", IsRequired=true)]
        public virtual string EntityName { get; set; }
    }

}

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