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
GetEntitySummary Parameters:
NameParameterData TypeRequiredDescription
EntityIDpathstringYesID of the entity
EntityNamepathstringYesName of the entity
EntitySummaryResponse Parameters:
NameParameterData TypeRequiredDescription
SummaryformstringNo

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: doapigw.baasbv.nl 
Accept: application/json

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

{"__type":"IDB.API.DTO.General.EntitySummaryResponse, IDB.API.DTO","Summary":"String"}