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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Summary":"String"}