GET api/Village/{village}/Checklist/{checklistId}?depth={depth}

Returns a single Checklist to the specified depth, with Village data

Request Information

URI Parameters

Name	Description	Type	Additional information
checklistId	The checklist to retrieve	globally unique identifier	Required
depth	Depth of tree. Values can be List or Item. Category is not permitted, and will be treated as List	ChecklistDepth	Default value is List
village		string	None.

Body Parameters

None.

Response Information

Resource Description

VillageChecklistModel

Name	Description	Type	Additional information
TotalItems	Total number of items in this checklist	integer	None.
ItemsCompleted	Total number of items completed in this checklist	integer	None.
Items	List of items in this checklist	Collection of VillageChecklistItemModel	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:

{
  "TotalItems": 1,
  "ItemsCompleted": 2,
  "Items": [
    {
      "Status": 0,
      "VillageId": "c1a2e9af-652e-4235-9ad2-2ad035624480",
      "Id": "edd85ba3-6d24-480b-bcb3-c03626b7e7ee",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Url": "sample string 5",
      "Sequence": 6
    },
    {
      "Status": 0,
      "VillageId": "c1a2e9af-652e-4235-9ad2-2ad035624480",
      "Id": "edd85ba3-6d24-480b-bcb3-c03626b7e7ee",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Url": "sample string 5",
      "Sequence": 6
    }
  ],
  "VillageId": "6ad75b8c-cdc8-4148-b55b-214a82e82a78",
  "Id": "03ecd8ef-661f-476f-b929-17ed3fb13c93",
  "Name": "sample string 5",
  "Description": "sample string 6",
  "Url": "sample string 7",
  "Sequence": 8
}

application/xml, text/xml

Sample:

<VillageChecklistModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Description>sample string 6</Description>
  <Id>03ecd8ef-661f-476f-b929-17ed3fb13c93</Id>
  <Name>sample string 5</Name>
  <Sequence>8</Sequence>
  <Url>sample string 7</Url>
  <VillageId>6ad75b8c-cdc8-4148-b55b-214a82e82a78</VillageId>
  <Items>
    <VillageChecklistItemModel>
      <Description>sample string 4</Description>
      <Id>edd85ba3-6d24-480b-bcb3-c03626b7e7ee</Id>
      <Name>sample string 3</Name>
      <Sequence>6</Sequence>
      <Url>sample string 5</Url>
      <VillageId>c1a2e9af-652e-4235-9ad2-2ad035624480</VillageId>
      <Status>NA</Status>
    </VillageChecklistItemModel>
    <VillageChecklistItemModel>
      <Description>sample string 4</Description>
      <Id>edd85ba3-6d24-480b-bcb3-c03626b7e7ee</Id>
      <Name>sample string 3</Name>
      <Sequence>6</Sequence>
      <Url>sample string 5</Url>
      <VillageId>c1a2e9af-652e-4235-9ad2-2ad035624480</VillageId>
      <Status>NA</Status>
    </VillageChecklistItemModel>
  </Items>
  <ItemsCompleted>2</ItemsCompleted>
  <TotalItems>1</TotalItems>
</VillageChecklistModel>