DigiOffice API Services Services

GetEntitySummary

Get the summary of an entity.

The following routes are available for this service:
GET	/api/entities/{EntityName}/{EntityID}/summary

"use strict";
export class EntitySummaryResponse {
    /** @param {{Summary?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Summary;
}
export class GetEntitySummary {
    /** @param {{EntityID?:string,EntityName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the entity */
    EntityID;
    /**
     * @type {string}
     * @description Name of the entity */
    EntityName;
}

JavaScript GetEntitySummary DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: test-do-services.klokgroep.nl 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Summary":"String"}