DigiOffice Gateway Web Services

<back to all web services

GetTextBlockLocations

Get text block locations for use in DigiOffice for Office add-ins

Requires Authentication
The following routes are available for this service:
GET/api/textblocklocations
GetTextBlockLocations Parameters:
NameParameterData TypeRequiredDescription
AccessFilterqueryTextBlockLocationAccessFilterYesAccess filter. Possible values: 'read' for all locations where user can read text blocks in the given location. 'write' for all locations where user can store their text blocks.

Allowable Values

  • Read
  • Write

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/textblocklocations HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv

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

[
	{
		__type: "IDB.API.DTO.Document.TextBlockLocation, IDB.API.DTO",
		Name: String,
		Description: String,
		Type: WordBlockManagement,
		Order: 0,
		FontAwesomeIcon: String,
		Filter: String,
		Location: String
	}
]