PUT api/v1/portals/{portalUid}/customer/diarytypes/{diaryTypeGuid}

Update a diary type in the given customer portal

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalUid

the customer portal

globally unique identifier

Required

diaryTypeGuid

the diary type to update

globally unique identifier

Required

Body Parameters

the details to update

DiaryType
NameDescriptionTypeAdditional information
Name

The name of the qualification.

string

Required

String length: inclusive between 0 and 100

DiaryTypeCategory

The diary type category

globally unique identifier

Required

Portal

The portal this diary type is related to

globally unique identifier

Required

Company

The company this diary type is related to

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "DiaryTypeCategory": "056a9155-312b-4f1d-a906-7972113816f3",
  "Portal": "86de4dab-df86-4619-bcb0-ae980ec64791",
  "Company": "279e00be-4674-434e-8f47-8962ea2ec464"
}

application/xml, text/xml

Sample:
<DiaryType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Company>279e00be-4674-434e-8f47-8962ea2ec464</Company>
  <DiaryTypeCategory>056a9155-312b-4f1d-a906-7972113816f3</DiaryTypeCategory>
  <Name>sample string 1</Name>
  <Portal>86de4dab-df86-4619-bcb0-ae980ec64791</Portal>
</DiaryType>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

updated diary type

DiaryTypeViewModel
NameDescriptionTypeAdditional 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": "56cfb71f-c311-4447-8f61-558bf295c46f",
  "Category": {
    "Name": "sample string 1",
    "IsAvailable": true,
    "Uid": "20b5288f-a424-4867-a6fd-52ae9398efb1",
    "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:23.478357+00:00",
    "UpdatedBy": "sample string 4"
  },
  "Uid": "3aff868c-330b-4f3d-afc1-ec614bfaa866",
  "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:23.478357+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:23.478357+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>3aff868c-330b-4f3d-afc1-ec614bfaa866</Uid>
  <UpdatedBy>sample string 4</UpdatedBy>
  <Category>
    <DateUpdated>2025-10-27T13:56:23.478357+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>20b5288f-a424-4867-a6fd-52ae9398efb1</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <IsAvailable>true</IsAvailable>
    <Name>sample string 1</Name>
  </Category>
  <DiaryTypeGuid>56cfb71f-c311-4447-8f61-558bf295c46f</DiaryTypeGuid>
  <Name>sample string 1</Name>
</DiaryTypeViewModel>