DigiOffice Gateway Web Services

<back to all web services

GetEntityIdentifier

Returns the identifier information of an entity.

Requires Authentication
The following routes are available for this service:
GET/api/entities/{EntityName}/{EntityID}
GetEntityIdentifier Parameters:
NameParameterData TypeRequiredDescription
EntityIDpathstringYesID of the entity
EntityNamepathstringYesName of the entity
CommonEntityIdentifier Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
DisplayNameformstringNo
EntityNameformstringNo

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/entities/{EntityName}/{EntityID} HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml

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

<CommonEntityIdentifier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.General">
  <DisplayName>String</DisplayName>
  <EntityName>String</EntityName>
  <ID>String</ID>
</CommonEntityIdentifier>