POST PlanCare2Api/Relations/Note

Insert note.

Requires 'Edit' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

Request Information

URI Parameters

None.

Body Parameters

RelationNote.

RelationNote
Name Description Type Additional information
Id

The internal id of the note

integer

-

TypeGuid

The internal id of type of the note

globally unique identifier

-

RelationId

The internal id of the relation

integer

-

Date

The date of the note

date

-

Text

The text of the note

string

-

Visibility

The visibility of the note

RelationNoteVisibility

-

DisciplineIds

Id's of disciplines for which the note is visible when visibility is restricted for disciplines

Collection of integer

-

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "TypeGuid": "e1a3d77b-bb5f-4193-b3b3-1a3a91ac7119",
  "RelationId": 3,
  "Date": "2026-05-26T22:06:12.6806028+02:00",
  "Text": "sample string 5",
  "Visibility": 0,
  "DisciplineIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<RelationNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <Date>2026-05-26T22:06:12.6806028+02:00</Date>
  <DisciplineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DisciplineIds>
  <Id>1</Id>
  <RelationId>3</RelationId>
  <Text>sample string 5</Text>
  <TypeGuid>e1a3d77b-bb5f-4193-b3b3-1a3a91ac7119</TypeGuid>
  <Visibility>PublicForAllDisciplines</Visibility>
</RelationNote>

Response Information

Resource Description

HttpResponseMessage
Name Description Type Additional information
Version

Version

-

Content

HttpContent

-

StatusCode

HttpStatusCode

-

ReasonPhrase

string

-

Headers

Collection of Object

-

RequestMessage

HttpRequestMessage

-

IsSuccessStatusCode

boolean

-