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}

namespace IDB.API.DTO.General

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CommonEntityIdentifier() = 
        member val ID:String = null with get,set
        member val DisplayName:String = null with get,set
        member val EntityName:String = null with get,set

    ///<summary>
    ///Returns the identifier information of an entity.
    ///</summary>
    [<Api(Description="Returns the identifier information of an entity.")>]
    [<AllowNullLiteral>]
    type GetEntityIdentifier() = 
        ///<summary>
        ///ID of the entity
        ///</summary>
        [<ApiMember(Description="ID of the entity", IsRequired=true)>]
        member val EntityID:String = null with get,set

        ///<summary>
        ///Name of the entity
        ///</summary>
        [<ApiMember(Description="Name of the entity", IsRequired=true)>]
        member val EntityName:String = null with get,set

F# GetEntityIdentifier DTOs

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

HTTP + CSV

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: text/csv

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

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