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 .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/textblocklocations HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml

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

<ArrayOfTextBlockLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <TextBlockLocation>
    <Description>String</Description>
    <Filter>String</Filter>
    <FontAwesomeIcon>String</FontAwesomeIcon>
    <Location>String</Location>
    <Name>String</Name>
    <Order>0</Order>
    <Type>WordBlockManagement</Type>
  </TextBlockLocation>
</ArrayOfTextBlockLocation>