DigiOffice API Services Services

GetEntityIdentifier

Returns the identifier information of an entity.

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

"use strict";
export class CommonEntityIdentifier {
    /** @param {{ID?:string,DisplayName?:string,EntityName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    DisplayName;
    /** @type {string} */
    EntityName;
}
export class GetEntityIdentifier {
    /** @param {{EntityID?:string,EntityName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the entity */
    EntityID;
    /**
     * @type {string}
     * @description Name of the entity */
    EntityName;
}

JavaScript GetEntityIdentifier DTOs

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/entities/{EntityName}/{EntityID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv

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

{
	ID: String,
	DisplayName: String,
	EntityName: String
}