PUT api/Preferences/{villageId}

Updates the current user's preferences for the specified village

Request Information

URI Parameters

Name	Description	Type	Additional information
villageId		globally unique identifier	Required

Body Parameters

UpdateVillagePreferencesModel

Name	Description	Type	Additional information
VillagePush	Settings for Village/Village Membership Push Notifications	VillageMembership	None.
VillageEmail	Settings for Village/Village Membership Email Notifications	VillageMembership	None.
MessagingPush	Settings for Messaging Push Notifications	Messaging	None.
MessagingEmail	Settings for Messaging Email Notifications	Messaging	None.
WellnessJournalPush	Settings for Wellness Journal Push Notifications	WellnessJournal	None.
WellnessJournalEmail	Settings for Wellness Journal Email Notifications	WellnessJournal	None.
CarePlanPush	Settings for Care Plan Push Notifications	CarePlans	None.
CarePlanEmail	Settings for Care Plan Email Notifications	CarePlans	None.
EventPush	Settings for Event Push Notifications	Event	None.
EventEmail	Settings for Event Email Notifications	Event	None.
TodoPush	Settings for To Do Push Notifications	Todo	None.
TodoEmail	Settings for To Do Email Notifications	Todo	None.
DocumentPush	Settings for Document Push Notifications	Document	None.
DocumentEmail	Settings for Document Email Notifications	Document	None.
MedicationPush	Settings for Medication Push Notifications	Medications	None.
MedicationEmail	Settings for Medication Email Notifications	Medications	None.
OtherEmail	Settings for Other Email Notifications	Other	None.
OtherPush	Settings for Other Push Notifications	Other	None.

Request Formats

application/json, text/json

Sample:

{
  "VillagePush": 1,
  "VillageEmail": 1,
  "MessagingPush": 1,
  "MessagingEmail": 1,
  "WellnessJournalPush": 2,
  "WellnessJournalEmail": 2,
  "CarePlanPush": 1,
  "CarePlanEmail": 1,
  "EventPush": 1,
  "EventEmail": 1,
  "TodoPush": 1,
  "TodoEmail": 1,
  "DocumentPush": 1,
  "DocumentEmail": 1,
  "MedicationPush": 1,
  "MedicationEmail": 1,
  "OtherEmail": 1,
  "OtherPush": 1
}

application/xml, text/xml

Sample:

<UpdateVillagePreferencesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <CarePlanEmail>Started</CarePlanEmail>
  <CarePlanPush>Started</CarePlanPush>
  <DocumentEmail>Uploaded</DocumentEmail>
  <DocumentPush>Uploaded</DocumentPush>
  <EventEmail>Created</EventEmail>
  <EventPush>Created</EventPush>
  <MedicationEmail>TimeToTake</MedicationEmail>
  <MedicationPush>TimeToTake</MedicationPush>
  <MessagingEmail>BroadcastMessage</MessagingEmail>
  <MessagingPush>BroadcastMessage</MessagingPush>
  <OtherEmail>WeeklyDigest</OtherEmail>
  <OtherPush>WeeklyDigest</OtherPush>
  <TodoEmail>Created</TodoEmail>
  <TodoPush>Created</TodoPush>
  <VillageEmail>MemberJoin</VillageEmail>
  <VillagePush>MemberJoin</VillagePush>
  <WellnessJournalEmail>NewJournal</WellnessJournalEmail>
  <WellnessJournalPush>NewJournal</WellnessJournalPush>
</UpdateVillagePreferencesModel>

multipart/form-data

Sample:

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

Response Information

Resource Description

PrimitiveOfBoolean

Name	Description	Type	Additional information
value		boolean	Required

Response Formats

application/json, text/json

Sample:

{
  "value": true
}

application/xml, text/xml

Sample:

<PrimitiveOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.API.Models">
  <value>true</value>
</PrimitiveOfboolean>