POST api/v1/portals/{portalUid}/customer/diarytypes
Create a new diary type in the given portal
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
the portal to create the diary type in |
globally unique identifier |
Required |
Body Parameters
the diary type to create
DiaryType| Name | Description | Type | Additional 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": "2f3aaf73-1b37-4e3c-b123-1a031ab84a53",
"Portal": "6d280b31-4bf8-4227-beca-361f28ecacb5",
"Company": "bd72acc7-2774-460b-82df-c0d4493bc4e1"
}
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>bd72acc7-2774-460b-82df-c0d4493bc4e1</Company> <DiaryTypeCategory>2f3aaf73-1b37-4e3c-b123-1a031ab84a53</DiaryTypeCategory> <Name>sample string 1</Name> <Portal>6d280b31-4bf8-4227-beca-361f28ecacb5</Portal> </DiaryType>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
the created diary type
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": "7c01d6d7-74ba-40e4-99dc-0bb4268b1f46",
"Category": {
"Name": "sample string 1",
"IsAvailable": true,
"Uid": "69ec8f4b-e5a3-4895-869d-7f6c92eb840d",
"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:32.8896839+00:00",
"UpdatedBy": "sample string 4"
},
"Uid": "3aacf869-3f3f-4417-8f98-3a2bb71dbeb7",
"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:32.8896839+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-27T14:00:32.8896839+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>3aacf869-3f3f-4417-8f98-3a2bb71dbeb7</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<Category>
<DateUpdated>2025-10-27T14:00:32.8896839+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>69ec8f4b-e5a3-4895-869d-7f6c92eb840d</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<IsAvailable>true</IsAvailable>
<Name>sample string 1</Name>
</Category>
<DiaryTypeGuid>7c01d6d7-74ba-40e4-99dc-0bb4268b1f46</DiaryTypeGuid>
<Name>sample string 1</Name>
</DiaryTypeViewModel>