PUT api/Village/{village}/Journal/{id}

Update an existing journal entry for the village

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
village		string	None.

Body Parameters

ApiJournalUpdateModel

Name	Description	Type	Additional 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": [
    "b9ccd904-5e04-4252-b252-6c479bed0bd3",
    "5656256e-a300-4d1f-b0f7-fb344c2dbcac"
  ],
  "MoodFamilyId": "483d83be-067d-4463-aa13-3c79a29414a5",
  "MoodIds": [
    "c1c45b7c-e830-4520-ae03-f1243f5a3cfe",
    "3a4ae136-d92f-42a4-8d2c-d4a6f48db6de"
  ],
  "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

Name	Description	Type	Additional 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": "c8b02739-a5f3-41cd-8d08-cfa00bd708f7",
  "VillageId": "3474e590-d496-491d-aa61-e8bab295f3ed",
  "PerformedById": "4416db64-cd3f-42e8-9f85-75ee818d2d22",
  "PerformedBy": "sample string 6",
  "Wellness": 0,
  "MoodFamilyId": "94dc0c69-2d20-4531-8b52-0d23529c168c",
  "MoodIds": [
    "53ed2569-2f94-4978-a6d2-40df7a32fb69",
    "e3e80fcb-f42e-423a-b1d0-866106ee72c8"
  ],
  "SymptomIds": [
    "1c95a39e-6746-4df0-b58c-54f34f290df1",
    "30a95f5a-1385-4deb-a3cd-50c82b87dd3a"
  ],
  "Comment": "sample string 7",
  "DateTime": "2025-06-03T04:59:37.449+00:00",
  "JournalType": 0,
  "UpdatedById": "f8b2f0ae-7e9b-462f-b893-8a054f740dc1",
  "UpdatedBy": "sample string 12",
  "Updated": "2025-06-03T04:59:37.449+00:00",
  "HasPhoto": true,
  "Comments": [
    {
      "CommentId": "9969389a-57fc-4cb8-bdde-ba5b874b0d23",
      "JournalId": "e8d464da-dda4-479a-9ab4-7dea9f3dfbe5",
      "VillageId": "499a435d-8fb7-497c-b711-3058a1e40d24",
      "Comment": "sample string 4",
      "CreatedBy": "sample string 7",
      "CreatedById": "aca8a5c0-8c01-4a7a-bd5b-438ec007a4b7",
      "Created": "2025-06-03T04:59:37.449+00:00",
      "Updated": "2025-06-03T04:59:37.449+00:00",
      "UpdatedById": "72d29ddf-d6ec-4695-9ba4-dc8e3ee487c8",
      "UpdatedBy": "sample string 14",
      "Likes": [
        "c1c70287-4bca-444d-957a-db1d4ddf1720",
        "d7ee4c78-a45e-4b42-99df-7b96b49de69f"
      ],
      "ParentCommentId": "7ae72b24-4d33-4908-849d-9eeb57a10b6a",
      "Deleted": true
    },
    {
      "CommentId": "9969389a-57fc-4cb8-bdde-ba5b874b0d23",
      "JournalId": "e8d464da-dda4-479a-9ab4-7dea9f3dfbe5",
      "VillageId": "499a435d-8fb7-497c-b711-3058a1e40d24",
      "Comment": "sample string 4",
      "CreatedBy": "sample string 7",
      "CreatedById": "aca8a5c0-8c01-4a7a-bd5b-438ec007a4b7",
      "Created": "2025-06-03T04:59:37.449+00:00",
      "Updated": "2025-06-03T04:59:37.449+00:00",
      "UpdatedById": "72d29ddf-d6ec-4695-9ba4-dc8e3ee487c8",
      "UpdatedBy": "sample string 14",
      "Likes": [
        "c1c70287-4bca-444d-957a-db1d4ddf1720",
        "d7ee4c78-a45e-4b42-99df-7b96b49de69f"
      ],
      "ParentCommentId": "7ae72b24-4d33-4908-849d-9eeb57a10b6a",
      "Deleted": true
    }
  ],
  "Attachments": [
    {
      "Id": "7c5887d3-b87d-4f39-aad0-36c053154828",
      "Size": 2,
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "UploadedBy": "sample string 5"
    },
    {
      "Id": "7c5887d3-b87d-4f39-aad0-36c053154828",
      "Size": 2,
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "UploadedBy": "sample string 5"
    }
  ],
  "Likes": [
    "1822b0ec-6253-45bc-994f-303af4598b38",
    "dede491c-e85d-44b6-a0d2-20ae1a1c409f"
  ]
}

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>7c5887d3-b87d-4f39-aad0-36c053154828</Id>
      <Size>2</Size>
      <UploadedBy>sample string 5</UploadedBy>
    </AttachmentModel>
    <AttachmentModel>
      <ContentType>sample string 4</ContentType>
      <FileName>sample string 3</FileName>
      <Id>7c5887d3-b87d-4f39-aad0-36c053154828</Id>
      <Size>2</Size>
      <UploadedBy>sample string 5</UploadedBy>
    </AttachmentModel>
  </Attachments>
  <Comment>sample string 7</Comment>
  <Comments>
    <JournalEntryCommentModel>
      <Comment>sample string 4</Comment>
      <CommentId>9969389a-57fc-4cb8-bdde-ba5b874b0d23</CommentId>
      <Created>2025-06-03T04:59:37.4495582+00:00</Created>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedByFirstName>sample string 5</CreatedByFirstName>
      <CreatedById>aca8a5c0-8c01-4a7a-bd5b-438ec007a4b7</CreatedById>
      <CreatedByLastName>sample string 6</CreatedByLastName>
      <Deleted>true</Deleted>
      <JournalId>e8d464da-dda4-479a-9ab4-7dea9f3dfbe5</JournalId>
      <Likes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>c1c70287-4bca-444d-957a-db1d4ddf1720</d4p1:guid>
        <d4p1:guid>d7ee4c78-a45e-4b42-99df-7b96b49de69f</d4p1:guid>
      </Likes>
      <ParentCommentId>7ae72b24-4d33-4908-849d-9eeb57a10b6a</ParentCommentId>
      <Updated>2025-06-03T04:59:37.4495582+00:00</Updated>
      <UpdatedBy>sample string 14</UpdatedBy>
      <UpdatedByFirstName>sample string 12</UpdatedByFirstName>
      <UpdatedById>72d29ddf-d6ec-4695-9ba4-dc8e3ee487c8</UpdatedById>
      <UpdatedByLastName>sample string 13</UpdatedByLastName>
      <VillageId>499a435d-8fb7-497c-b711-3058a1e40d24</VillageId>
    </JournalEntryCommentModel>
    <JournalEntryCommentModel>
      <Comment>sample string 4</Comment>
      <CommentId>9969389a-57fc-4cb8-bdde-ba5b874b0d23</CommentId>
      <Created>2025-06-03T04:59:37.4495582+00:00</Created>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedByFirstName>sample string 5</CreatedByFirstName>
      <CreatedById>aca8a5c0-8c01-4a7a-bd5b-438ec007a4b7</CreatedById>
      <CreatedByLastName>sample string 6</CreatedByLastName>
      <Deleted>true</Deleted>
      <JournalId>e8d464da-dda4-479a-9ab4-7dea9f3dfbe5</JournalId>
      <Likes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>c1c70287-4bca-444d-957a-db1d4ddf1720</d4p1:guid>
        <d4p1:guid>d7ee4c78-a45e-4b42-99df-7b96b49de69f</d4p1:guid>
      </Likes>
      <ParentCommentId>7ae72b24-4d33-4908-849d-9eeb57a10b6a</ParentCommentId>
      <Updated>2025-06-03T04:59:37.4495582+00:00</Updated>
      <UpdatedBy>sample string 14</UpdatedBy>
      <UpdatedByFirstName>sample string 12</UpdatedByFirstName>
      <UpdatedById>72d29ddf-d6ec-4695-9ba4-dc8e3ee487c8</UpdatedById>
      <UpdatedByLastName>sample string 13</UpdatedByLastName>
      <VillageId>499a435d-8fb7-497c-b711-3058a1e40d24</VillageId>
    </JournalEntryCommentModel>
  </Comments>
  <DateTime>2025-06-03T04:59:37.4495582+00:00</DateTime>
  <JournalId>c8b02739-a5f3-41cd-8d08-cfa00bd708f7</JournalId>
  <JournalType>Default</JournalType>
  <Likes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1822b0ec-6253-45bc-994f-303af4598b38</d2p1:guid>
    <d2p1:guid>dede491c-e85d-44b6-a0d2-20ae1a1c409f</d2p1:guid>
  </Likes>
  <MoodFamilyId>94dc0c69-2d20-4531-8b52-0d23529c168c</MoodFamilyId>
  <MoodIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>53ed2569-2f94-4978-a6d2-40df7a32fb69</d2p1:guid>
    <d2p1:guid>e3e80fcb-f42e-423a-b1d0-866106ee72c8</d2p1:guid>
  </MoodIds>
  <PerformedBy>sample string 6</PerformedBy>
  <PerformedByFirstName>sample string 4</PerformedByFirstName>
  <PerformedById>4416db64-cd3f-42e8-9f85-75ee818d2d22</PerformedById>
  <PerformedByLastName>sample string 5</PerformedByLastName>
  <SymptomIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1c95a39e-6746-4df0-b58c-54f34f290df1</d2p1:guid>
    <d2p1:guid>30a95f5a-1385-4deb-a3cd-50c82b87dd3a</d2p1:guid>
  </SymptomIds>
  <Updated>2025-06-03T04:59:37.4495582+00:00</Updated>
  <UpdatedBy>sample string 12</UpdatedBy>
  <UpdatedByFirstName>sample string 10</UpdatedByFirstName>
  <UpdatedById>f8b2f0ae-7e9b-462f-b893-8a054f740dc1</UpdatedById>
  <UpdatedByLastName>sample string 11</UpdatedByLastName>
  <VillageId>3474e590-d496-491d-aa61-e8bab295f3ed</VillageId>
  <Wellness>Good</Wellness>
</JournalEntryModel>