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


export class EntitySummaryResponse
{
    public Summary?: string;

    public constructor(init?: Partial<EntitySummaryResponse>) { (Object as any).assign(this, init); }
}

/**
* Get the summary of an entity.
*/
// @Api(Description="Get the summary of an entity.")
export class GetEntitySummary
{
    /**
    * ID of the entity
    */
    // @ApiMember(Description="ID of the entity", IsRequired=true)
    public EntityID?: string;

    /**
    * Name of the entity
    */
    // @ApiMember(Description="Name of the entity", IsRequired=true)
    public EntityName?: string;

    public constructor(init?: Partial<GetEntitySummary>) { (Object as any).assign(this, init); }
}

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