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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get the summary of an entity.
    */
    @Api(Description="Get the summary of an entity.")
    public static class GetEntitySummary
    {
        /**
        * ID of the entity
        */
        @ApiMember(Description="ID of the entity", IsRequired=true)
        public String EntityID = null;

        /**
        * Name of the entity
        */
        @ApiMember(Description="Name of the entity", IsRequired=true)
        public String EntityName = null;
        
        public String getEntityID() { return EntityID; }
        public GetEntitySummary setEntityID(String value) { this.EntityID = value; return this; }
        public String getEntityName() { return EntityName; }
        public GetEntitySummary setEntityName(String value) { this.EntityName = value; return this; }
    }

    public static class EntitySummaryResponse
    {
        public String Summary = null;
        
        public String getSummary() { return Summary; }
        public EntitySummaryResponse setSummary(String value) { this.Summary = value; return this; }
    }

}

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