PUT api/Village/{village}/Journal

Provide a new journal entry for the village

Request Information

URI Parameters

NameDescriptionTypeAdditional information
village

string

None.

Body Parameters

ApiJournalUpdateModel
NameDescriptionTypeAdditional information
file

The file to be uploaded

 ApiFileUpload

None.
Wellness

The care recipient's Wellness indicator as of this update

 Wellness

None.
SymptomIds

The care recipient's symptoms as of this update

 Collection of globally unique identifier

None.
MoodFamilyId

The care recipient's mood (high level mood family)

 globally unique identifier

None.
MoodIds

The care recipient's detailed mood

 Collection of globally unique identifier

None.
Comment

A user-supplied comment, if any

 string

String length: inclusive between 0 and 32768
RemovePhoto

If true, remove the existing journal entry

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "file": null,
  "Wellness": 0,
  "SymptomIds": [
    "b144fffd-0bff-44e1-b310-9dd8d9781edf",
    "d9542c74-12c9-4bec-a78c-08f4e45ad7e6"
  ],
  "MoodFamilyId": "f4156a6e-c7af-471c-b4d3-4bfcc1fcd98e",
  "MoodIds": [
    "f8419265-6a6e-4c7f-8c82-77b566ff893c",
    "775de110-cdf5-4f0e-ae00-a5eb5d7203e0"
  ],
  "Comment": "sample string 1",
  "RemovePhoto": true
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'CaringVillage.API.Models.ApiFileUpload' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'CaringVillage.API.Models.ApiFileUpload' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'MultipartMediaTypeFormatter' to write type 'ApiJournalUpdateModel'.

Response Information

Resource Description

JournalEntryModel
NameDescriptionTypeAdditional information
JournalId

The unique ID of this journal entry

 globally unique identifier

None.
VillageId

The Village's ID

 globally unique identifier

None.
PerformedById

The ID of the user who created the entry

 globally unique identifier

None.
PerformedBy

Name of the user who created the entry

 string

None.
Wellness

The care recipient's Wellness indicator as of this update

 Wellness

None.
MoodFamilyId

The care recipient's mood (high level mood family)

 globally unique identifier

None.
MoodIds

The care recipient's detailed mood

 Collection of globally unique identifier

None.
SymptomIds

The care recipient's symptoms as if this update

 Collection of globally unique identifier

None.
Comment

A user-supplied journal text, if any

 string

None.
DateTime

The date/time this journal entry was created

 date

None.
JournalType

Type of journal entry - obsolete

 JournalType

None.
UpdatedById

ID of the user who performed the update

 globally unique identifier

None.
UpdatedBy

Name of the user who updated

 string

None.
Updated

When the entry was updated

 date

None.
HasPhoto

Whether or not the journal entry has a photo (legacy)

 boolean

None.
Comments

Comments made on the journal entry

 Collection of JournalEntryCommentModel

None.
Attachments

Collection of AttachmentModel

None.
Likes

Collection of globally unique identifier

None.

Response Formats

application/json, text/json

Sample: 
{
  "JournalId": "ffe0ef4c-e789-41bd-952e-e9f3de395032",
  "VillageId": "74ecd873-557e-45e8-87b2-e39255e65558",
  "PerformedById": "17a00e8f-95c5-41a9-b686-075f80f9a4a1",
  "PerformedBy": "sample string 6",
  "Wellness": 0,
  "MoodFamilyId": "0eade593-794c-4e6b-9965-64c09079d1b9",
  "MoodIds": [
    "2e05a5c5-caf1-4916-bd16-8cd49ac0c54d",
    "b07865e2-07b2-4de1-a138-719504965226"
  ],
  "SymptomIds": [
    "7e44a812-7000-4241-a458-05192acceac9",
    "239f31b7-0f7c-48f9-88b2-03ba4fb26a4e"
  ],
  "Comment": "sample string 7",
  "DateTime": "2025-06-03T04:39:47.478+00:00",
  "JournalType": 0,
  "UpdatedById": "839b0b7a-0f3a-4efe-b473-ed468cd4b530",
  "UpdatedBy": "sample string 12",
  "Updated": "2025-06-03T04:39:47.478+00:00",
  "HasPhoto": true,
  "Comments": [
    {
      "CommentId": "4af865bb-364e-43c5-8e16-7b51fcb6206d",
      "JournalId": "58083d88-bf7c-4946-b786-f35641dab6c2",
      "VillageId": "5a001b8f-8485-493a-b3fe-d6eec8164188",
      "Comment": "sample string 4",
      "CreatedBy": "sample string 7",
      "CreatedById": "485bdcd9-13b2-407c-b31e-8b1f0c39af15",
      "Created": "2025-06-03T04:39:47.478+00:00",
      "Updated": "2025-06-03T04:39:47.478+00:00",
      "UpdatedById": "1155c9e6-4ea8-4644-983d-993c9e243f46",
      "UpdatedBy": "sample string 14",
      "Likes": [
        "07c9d4c4-b37e-4ea4-bb9e-50d9c7260b35",
        "f2a8d6b0-afaa-4722-896e-1e331c9350e4"
      ],
      "ParentCommentId": "408c1de3-bcee-4ab7-997c-a9459177e51d",
      "Deleted": true
    },
    {
      "CommentId": "4af865bb-364e-43c5-8e16-7b51fcb6206d",
      "JournalId": "58083d88-bf7c-4946-b786-f35641dab6c2",
      "VillageId": "5a001b8f-8485-493a-b3fe-d6eec8164188",
      "Comment": "sample string 4",
      "CreatedBy": "sample string 7",
      "CreatedById": "485bdcd9-13b2-407c-b31e-8b1f0c39af15",
      "Created": "2025-06-03T04:39:47.478+00:00",
      "Updated": "2025-06-03T04:39:47.478+00:00",
      "UpdatedById": "1155c9e6-4ea8-4644-983d-993c9e243f46",
      "UpdatedBy": "sample string 14",
      "Likes": [
        "07c9d4c4-b37e-4ea4-bb9e-50d9c7260b35",
        "f2a8d6b0-afaa-4722-896e-1e331c9350e4"
      ],
      "ParentCommentId": "408c1de3-bcee-4ab7-997c-a9459177e51d",
      "Deleted": true
    }
  ],
  "Attachments": [
    {
      "Id": "9eb2183b-fe95-4d76-8f9f-625d00934477",
      "Size": 2,
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "UploadedBy": "sample string 5"
    },
    {
      "Id": "9eb2183b-fe95-4d76-8f9f-625d00934477",
      "Size": 2,
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "UploadedBy": "sample string 5"
    }
  ],
  "Likes": [
    "7db24e12-d996-4d8a-8831-ed351cb7e3ad",
    "7d9a5c02-d23e-47e9-ba4d-550ad7fcb2fc"
  ]
}

application/xml, text/xml

Sample: 
<JournalEntryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Attachments>
    <AttachmentModel>
      <ContentType>sample string 4</ContentType>
      <FileName>sample string 3</FileName>
      <Id>9eb2183b-fe95-4d76-8f9f-625d00934477</Id>
      <Size>2</Size>
      <UploadedBy>sample string 5</UploadedBy>
    </AttachmentModel>
    <AttachmentModel>
      <ContentType>sample string 4</ContentType>
      <FileName>sample string 3</FileName>
      <Id>9eb2183b-fe95-4d76-8f9f-625d00934477</Id>
      <Size>2</Size>
      <UploadedBy>sample string 5</UploadedBy>
    </AttachmentModel>
  </Attachments>
  <Comment>sample string 7</Comment>
  <Comments>
    <JournalEntryCommentModel>
      <Comment>sample string 4</Comment>
      <CommentId>4af865bb-364e-43c5-8e16-7b51fcb6206d</CommentId>
      <Created>2025-06-03T04:39:47.4780813+00:00</Created>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedByFirstName>sample string 5</CreatedByFirstName>
      <CreatedById>485bdcd9-13b2-407c-b31e-8b1f0c39af15</CreatedById>
      <CreatedByLastName>sample string 6</CreatedByLastName>
      <Deleted>true</Deleted>
      <JournalId>58083d88-bf7c-4946-b786-f35641dab6c2</JournalId>
      <Likes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>07c9d4c4-b37e-4ea4-bb9e-50d9c7260b35</d4p1:guid>
        <d4p1:guid>f2a8d6b0-afaa-4722-896e-1e331c9350e4</d4p1:guid>
      </Likes>
      <ParentCommentId>408c1de3-bcee-4ab7-997c-a9459177e51d</ParentCommentId>
      <Updated>2025-06-03T04:39:47.4780813+00:00</Updated>
      <UpdatedBy>sample string 14</UpdatedBy>
      <UpdatedByFirstName>sample string 12</UpdatedByFirstName>
      <UpdatedById>1155c9e6-4ea8-4644-983d-993c9e243f46</UpdatedById>
      <UpdatedByLastName>sample string 13</UpdatedByLastName>
      <VillageId>5a001b8f-8485-493a-b3fe-d6eec8164188</VillageId>
    </JournalEntryCommentModel>
    <JournalEntryCommentModel>
      <Comment>sample string 4</Comment>
      <CommentId>4af865bb-364e-43c5-8e16-7b51fcb6206d</CommentId>
      <Created>2025-06-03T04:39:47.4780813+00:00</Created>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedByFirstName>sample string 5</CreatedByFirstName>
      <CreatedById>485bdcd9-13b2-407c-b31e-8b1f0c39af15</CreatedById>
      <CreatedByLastName>sample string 6</CreatedByLastName>
      <Deleted>true</Deleted>
      <JournalId>58083d88-bf7c-4946-b786-f35641dab6c2</JournalId>
      <Likes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>07c9d4c4-b37e-4ea4-bb9e-50d9c7260b35</d4p1:guid>
        <d4p1:guid>f2a8d6b0-afaa-4722-896e-1e331c9350e4</d4p1:guid>
      </Likes>
      <ParentCommentId>408c1de3-bcee-4ab7-997c-a9459177e51d</ParentCommentId>
      <Updated>2025-06-03T04:39:47.4780813+00:00</Updated>
      <UpdatedBy>sample string 14</UpdatedBy>
      <UpdatedByFirstName>sample string 12</UpdatedByFirstName>
      <UpdatedById>1155c9e6-4ea8-4644-983d-993c9e243f46</UpdatedById>
      <UpdatedByLastName>sample string 13</UpdatedByLastName>
      <VillageId>5a001b8f-8485-493a-b3fe-d6eec8164188</VillageId>
    </JournalEntryCommentModel>
  </Comments>
  <DateTime>2025-06-03T04:39:47.4780813+00:00</DateTime>
  <JournalId>ffe0ef4c-e789-41bd-952e-e9f3de395032</JournalId>
  <JournalType>Default</JournalType>
  <Likes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>7db24e12-d996-4d8a-8831-ed351cb7e3ad</d2p1:guid>
    <d2p1:guid>7d9a5c02-d23e-47e9-ba4d-550ad7fcb2fc</d2p1:guid>
  </Likes>
  <MoodFamilyId>0eade593-794c-4e6b-9965-64c09079d1b9</MoodFamilyId>
  <MoodIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>2e05a5c5-caf1-4916-bd16-8cd49ac0c54d</d2p1:guid>
    <d2p1:guid>b07865e2-07b2-4de1-a138-719504965226</d2p1:guid>
  </MoodIds>
  <PerformedBy>sample string 6</PerformedBy>
  <PerformedByFirstName>sample string 4</PerformedByFirstName>
  <PerformedById>17a00e8f-95c5-41a9-b686-075f80f9a4a1</PerformedById>
  <PerformedByLastName>sample string 5</PerformedByLastName>
  <SymptomIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>7e44a812-7000-4241-a458-05192acceac9</d2p1:guid>
    <d2p1:guid>239f31b7-0f7c-48f9-88b2-03ba4fb26a4e</d2p1:guid>
  </SymptomIds>
  <Updated>2025-06-03T04:39:47.4780813+00:00</Updated>
  <UpdatedBy>sample string 12</UpdatedBy>
  <UpdatedByFirstName>sample string 10</UpdatedByFirstName>
  <UpdatedById>839b0b7a-0f3a-4efe-b473-ed468cd4b530</UpdatedById>
  <UpdatedByLastName>sample string 11</UpdatedByLastName>
  <VillageId>74ecd873-557e-45e8-87b2-e39255e65558</VillageId>
  <Wellness>Good</Wellness>
</JournalEntryModel>