heilog.ch.Api

<back to all web services

GetEssencePreviewRequest

The following routes are available for this service:
GET/essence/preview
GetEssencePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
EssenceIdquerylongNo
GetEssencePreviewResponse Parameters:
NameParameterData TypeRequiredDescription
EssenceformEssencePreviewDtoNo
EssencePreviewDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
SummaryformstringNo
TextAttachmentformstringNo
FileNameformstringNo

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 /essence/preview HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEssencePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Essence">
  <Essence xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Essence">
    <d2p1:FileName>String</d2p1:FileName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Summary>String</d2p1:Summary>
    <d2p1:TextAttachment>String</d2p1:TextAttachment>
  </Essence>
</GetEssencePreviewResponse>