DigiOffice Gateway Web Services

GetEntityIdentifier

Returns the identifier information of an entity.

The following routes are available for this service:
GET	/api/entities/{EntityName}/{EntityID}

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Returns the identifier information of an entity.
*/
@Api(Description="Returns the identifier information of an entity.")
open class GetEntityIdentifier
{
    /**
    * ID of the entity
    */
    @ApiMember(Description="ID of the entity", IsRequired=true)
    var EntityID:String? = null

    /**
    * Name of the entity
    */
    @ApiMember(Description="Name of the entity", IsRequired=true)
    var EntityName:String? = null
}

open class CommonEntityIdentifier
{
    var ID:String? = null
    var DisplayName:String? = null
    var EntityName:String? = null
}

Kotlin GetEntityIdentifier DTOs

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>