GET api/Village/{village}/Medications
Get all medications
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
village | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MedicationListModelName | Description | Type | Additional information |
---|---|---|---|
VillageId |
Village ID |
globally unique identifier |
None. |
LastUpdated |
When the medication list was last updated |
date |
None. |
LastUpdatedBy |
Who last updated the medication list |
string |
None. |
Medications |
List of medications |
Collection of ViewMedicationModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "VillageId": "de788f7b-b1b2-4aae-86a5-f419e929a14d", "LastUpdated": "2025-06-03T05:24:03.086+00:00", "LastUpdatedBy": "sample string 3", "Medications": [ { "Id": "e93de9c3-84d6-47cd-bbc7-2c8fbbe03b66", "VillageId": "98402b91-c818-4d6d-bc92-aaa91fc988a8", "HasPillPhoto": true, "HasLabelPhoto": true, "Taken": [ { "LoggedById": "3d982d88-ced4-46df-832a-8c45ada446aa", "Taken": "2025-06-03T05:24:03.086+00:00" }, { "LoggedById": "3d982d88-ced4-46df-832a-8c45ada446aa", "Taken": "2025-06-03T05:24:03.086+00:00" } ], "Name": "sample string 5", "Form": "sample string 6", "StandardDosage": "sample string 7", "CustomDosage": "sample string 8", "Frequency": "sample string 9", "Active": true, "StartDate": "2025-06-03T05:24:03.086+00:00", "EndDate": "2025-06-03T05:24:03.086+00:00", "LastRefillDate": "2025-06-03T05:24:03.086+00:00", "RefillsRemaining": 1, "Reason": "sample string 11", "Notes": "sample string 12", "RXCUI": "sample string 13", "LastUpdated": "2025-06-03T05:24:03.086+00:00", "LastUpdatedBy": "sample string 15", "SendReminders": true, "MedicationFrequency": 0, "DaysOfWeek": 1, "NextDoseDate": "2025-06-03T05:24:03.086+00:00", "DailyFrequency": 0, "DailyTimesValue": 1, "DoseTimes": "sample string 17" }, { "Id": "e93de9c3-84d6-47cd-bbc7-2c8fbbe03b66", "VillageId": "98402b91-c818-4d6d-bc92-aaa91fc988a8", "HasPillPhoto": true, "HasLabelPhoto": true, "Taken": [ { "LoggedById": "3d982d88-ced4-46df-832a-8c45ada446aa", "Taken": "2025-06-03T05:24:03.086+00:00" }, { "LoggedById": "3d982d88-ced4-46df-832a-8c45ada446aa", "Taken": "2025-06-03T05:24:03.086+00:00" } ], "Name": "sample string 5", "Form": "sample string 6", "StandardDosage": "sample string 7", "CustomDosage": "sample string 8", "Frequency": "sample string 9", "Active": true, "StartDate": "2025-06-03T05:24:03.086+00:00", "EndDate": "2025-06-03T05:24:03.086+00:00", "LastRefillDate": "2025-06-03T05:24:03.086+00:00", "RefillsRemaining": 1, "Reason": "sample string 11", "Notes": "sample string 12", "RXCUI": "sample string 13", "LastUpdated": "2025-06-03T05:24:03.086+00:00", "LastUpdatedBy": "sample string 15", "SendReminders": true, "MedicationFrequency": 0, "DaysOfWeek": 1, "NextDoseDate": "2025-06-03T05:24:03.086+00:00", "DailyFrequency": 0, "DailyTimesValue": 1, "DoseTimes": "sample string 17" } ] }
application/xml, text/xml
Sample:
<MedicationListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <LastUpdated>2025-06-03T05:24:03.0863088+00:00</LastUpdated> <LastUpdatedBy>sample string 3</LastUpdatedBy> <Medications> <ViewMedicationModel> <Active>true</Active> <CustomDosage>sample string 8</CustomDosage> <DailyFrequency>None</DailyFrequency> <DailyTimesValue>1</DailyTimesValue> <DaysOfWeek>Sunday</DaysOfWeek> <DoseTimes>sample string 17</DoseTimes> <EndDate>2025-06-03T05:24:03.0863088+00:00</EndDate> <Form>sample string 6</Form> <Frequency>sample string 9</Frequency> <LastRefillDate>2025-06-03T05:24:03.0863088+00:00</LastRefillDate> <LastUpdated>2025-06-03T05:24:03.0863088+00:00</LastUpdated> <LastUpdatedBy>sample string 15</LastUpdatedBy> <MedicationFrequency>None</MedicationFrequency> <Name>sample string 5</Name> <NextDoseDate>2025-06-03T05:24:03.0863088+00:00</NextDoseDate> <Notes>sample string 12</Notes> <RXCUI>sample string 13</RXCUI> <Reason>sample string 11</Reason> <RefillsRemaining>1</RefillsRemaining> <SendReminders>true</SendReminders> <StandardDosage>sample string 7</StandardDosage> <StartDate>2025-06-03T05:24:03.0863088+00:00</StartDate> <HasLabelPhoto>true</HasLabelPhoto> <HasPillPhoto>true</HasPillPhoto> <Id>e93de9c3-84d6-47cd-bbc7-2c8fbbe03b66</Id> <Taken> <MedicationListTakenModel> <LoggedById>3d982d88-ced4-46df-832a-8c45ada446aa</LoggedById> <Taken>2025-06-03T05:24:03.0863088+00:00</Taken> </MedicationListTakenModel> <MedicationListTakenModel> <LoggedById>3d982d88-ced4-46df-832a-8c45ada446aa</LoggedById> <Taken>2025-06-03T05:24:03.0863088+00:00</Taken> </MedicationListTakenModel> </Taken> <VillageId>98402b91-c818-4d6d-bc92-aaa91fc988a8</VillageId> </ViewMedicationModel> <ViewMedicationModel> <Active>true</Active> <CustomDosage>sample string 8</CustomDosage> <DailyFrequency>None</DailyFrequency> <DailyTimesValue>1</DailyTimesValue> <DaysOfWeek>Sunday</DaysOfWeek> <DoseTimes>sample string 17</DoseTimes> <EndDate>2025-06-03T05:24:03.0863088+00:00</EndDate> <Form>sample string 6</Form> <Frequency>sample string 9</Frequency> <LastRefillDate>2025-06-03T05:24:03.0863088+00:00</LastRefillDate> <LastUpdated>2025-06-03T05:24:03.0863088+00:00</LastUpdated> <LastUpdatedBy>sample string 15</LastUpdatedBy> <MedicationFrequency>None</MedicationFrequency> <Name>sample string 5</Name> <NextDoseDate>2025-06-03T05:24:03.0863088+00:00</NextDoseDate> <Notes>sample string 12</Notes> <RXCUI>sample string 13</RXCUI> <Reason>sample string 11</Reason> <RefillsRemaining>1</RefillsRemaining> <SendReminders>true</SendReminders> <StandardDosage>sample string 7</StandardDosage> <StartDate>2025-06-03T05:24:03.0863088+00:00</StartDate> <HasLabelPhoto>true</HasLabelPhoto> <HasPillPhoto>true</HasPillPhoto> <Id>e93de9c3-84d6-47cd-bbc7-2c8fbbe03b66</Id> <Taken> <MedicationListTakenModel> <LoggedById>3d982d88-ced4-46df-832a-8c45ada446aa</LoggedById> <Taken>2025-06-03T05:24:03.0863088+00:00</Taken> </MedicationListTakenModel> <MedicationListTakenModel> <LoggedById>3d982d88-ced4-46df-832a-8c45ada446aa</LoggedById> <Taken>2025-06-03T05:24:03.0863088+00:00</Taken> </MedicationListTakenModel> </Taken> <VillageId>98402b91-c818-4d6d-bc92-aaa91fc988a8</VillageId> </ViewMedicationModel> </Medications> <VillageId>de788f7b-b1b2-4aae-86a5-f419e929a14d</VillageId> </MedicationListModel>