GET api/v1/portals/{portalUid}/customer/diarytypes/{diaryTypeGuid}
Get the diary type in the given customer portal
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
the customer portal |
globally unique identifier |
Required |
| diaryTypeGuid |
the diary type to get |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
the diary type if found
DiaryTypeViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name. |
string |
None. |
| DiaryTypeGuid |
The unique guid |
globally unique identifier |
None. |
| Category |
THe category of the diary type |
DiaryTypeCategoryViewModel |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"DiaryTypeGuid": "a8b0ff55-b835-42d0-b0a8-b0a0202a0e07",
"Category": {
"Name": "sample string 1",
"IsAvailable": true,
"Uid": "e37ce7dc-e50e-4511-9cf7-8984569c4086",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:56:21.2127318+00:00",
"UpdatedBy": "sample string 4"
},
"Uid": "20a62fdb-6b72-432c-bbf6-d5a2d65a6456",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:56:21.2127318+00:00",
"UpdatedBy": "sample string 4"
}
application/xml, text/xml
Sample:
<DiaryTypeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T13:56:21.2127318+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>20a62fdb-6b72-432c-bbf6-d5a2d65a6456</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<Category>
<DateUpdated>2025-10-27T13:56:21.2127318+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>e37ce7dc-e50e-4511-9cf7-8984569c4086</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<IsAvailable>true</IsAvailable>
<Name>sample string 1</Name>
</Category>
<DiaryTypeGuid>a8b0ff55-b835-42d0-b0a8-b0a0202a0e07</DiaryTypeGuid>
<Name>sample string 1</Name>
</DiaryTypeViewModel>