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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommonEntityIdentifier:
    id: Optional[str] = None
    display_name: Optional[str] = None
    entity_name: Optional[str] = None


# @Api(Description="Returns the identifier information of an entity.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEntityIdentifier:
    """
    Returns the identifier information of an entity.
    """

    # @ApiMember(Description="ID of the entity", IsRequired=true)
    entity_i_d: Optional[str] = None
    """
    ID of the entity
    """


    # @ApiMember(Description="Name of the entity", IsRequired=true)
    entity_name: Optional[str] = None
    """
    Name of the entity
    """

Python 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>