GET api/v1/portals/{portalUid}/diarytypes/categories

Gets the diary type categories.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	the current portal	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns all the diary type categories.

Collection of DiaryTypeCategoryViewModel

Name	Description	Type	Additional information
Name	The name.	string	None.
IsAvailable	Is the candidate available	boolean	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",
    "IsAvailable": true,
    "Uid": "4ae5c566-f120-4566-9e38-b217a00ae47f",
    "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-27T14:00:53.9119939+00:00",
    "UpdatedBy": "sample string 4"
  },
  {
    "Name": "sample string 1",
    "IsAvailable": true,
    "Uid": "4ae5c566-f120-4566-9e38-b217a00ae47f",
    "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-27T14:00:53.9119939+00:00",
    "UpdatedBy": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDiaryTypeCategoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DiaryTypeCategoryViewModel>
    <DateUpdated>2025-10-27T14:00:53.9119939+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>4ae5c566-f120-4566-9e38-b217a00ae47f</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <IsAvailable>true</IsAvailable>
    <Name>sample string 1</Name>
  </DiaryTypeCategoryViewModel>
  <DiaryTypeCategoryViewModel>
    <DateUpdated>2025-10-27T14:00:53.9119939+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>4ae5c566-f120-4566-9e38-b217a00ae47f</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <IsAvailable>true</IsAvailable>
    <Name>sample string 1</Name>
  </DiaryTypeCategoryViewModel>
</ArrayOfDiaryTypeCategoryViewModel>