GET api/Village/{village}/Checklist/{checklistId}/Items
Returns a list of Checklist Items in the specified Checklist, with Village data
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
checklistId |
The checklist from which to retrieve items |
globally unique identifier |
Required |
village | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of VillageChecklistItemModelName | Description | Type | Additional information |
---|---|---|---|
Status |
Completion status of this item |
ChecklistItemStatus |
None. |
VillageId |
Village ID |
globally unique identifier |
None. |
Id |
Unique ID |
globally unique identifier |
None. |
Name |
Name |
string |
None. |
Description |
Description |
string |
None. |
Url |
Navigation URL |
string |
None. |
Sequence |
Sequence in which this item should be displayed |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Status": 0, "VillageId": "8a0736ee-fda7-4a6f-8abf-c76f97a30989", "Id": "08e94d75-f55a-46d3-8cea-ae11a5130a48", "Name": "sample string 3", "Description": "sample string 4", "Url": "sample string 5", "Sequence": 6 }, { "Status": 0, "VillageId": "8a0736ee-fda7-4a6f-8abf-c76f97a30989", "Id": "08e94d75-f55a-46d3-8cea-ae11a5130a48", "Name": "sample string 3", "Description": "sample string 4", "Url": "sample string 5", "Sequence": 6 } ]
application/xml, text/xml
Sample:
<ArrayOfVillageChecklistItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <VillageChecklistItemModel> <Description>sample string 4</Description> <Id>08e94d75-f55a-46d3-8cea-ae11a5130a48</Id> <Name>sample string 3</Name> <Sequence>6</Sequence> <Url>sample string 5</Url> <VillageId>8a0736ee-fda7-4a6f-8abf-c76f97a30989</VillageId> <Status>NA</Status> </VillageChecklistItemModel> <VillageChecklistItemModel> <Description>sample string 4</Description> <Id>08e94d75-f55a-46d3-8cea-ae11a5130a48</Id> <Name>sample string 3</Name> <Sequence>6</Sequence> <Url>sample string 5</Url> <VillageId>8a0736ee-fda7-4a6f-8abf-c76f97a30989</VillageId> <Status>NA</Status> </VillageChecklistItemModel> </ArrayOfVillageChecklistItemModel>