| GET | /api/entities/{EntityName}/{EntityID} |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.General.Operations
Imports IDB.API.DTO.General
Namespace Global
Namespace IDB.API.DTO.General
Public Partial Class CommonEntityIdentifier
Public Overridable Property ID As String
Public Overridable Property DisplayName As String
Public Overridable Property EntityName As String
End Class
End Namespace
Namespace IDB.API.DTO.General.Operations
'''<Summary>
'''Returns the identifier information of an entity.
'''</Summary>
<Api(Description:="Returns the identifier information of an entity.")>
Public Partial Class GetEntityIdentifier
'''<Summary>
'''ID of the entity
'''</Summary>
<ApiMember(Description:="ID of the entity", IsRequired:=true)>
Public Overridable Property EntityID As String
'''<Summary>
'''Name of the entity
'''</Summary>
<ApiMember(Description:="Name of the entity", IsRequired:=true)>
Public Overridable Property EntityName As String
End Class
End Namespace
End Namespace
VB.NET GetEntityIdentifier DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>