GET api/Village/{village}/Checklists/Category/{categoryId}?depth={depth}

Return a single Checklist Category to the specified depth, with Village data

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryId	The ID of the category to retrieve	globally unique identifier	Required
depth	Depth of tree. Values can be Category, List, or Item. Item is the same as calling GET /All.	ChecklistDepth	Default value is Category
village		string	None.

Body Parameters

None.

Response Information

Resource Description

VillageChecklistCategoryModel

Name	Description	Type	Additional information
TotalItems	Sum of items across all checklists in this category	integer	None.
ItemsCompleted	Sum of items completed across all checklists in this category	integer	None.
Lists	List of checklists in this category	Collection of VillageChecklistModel	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,
  "Lists": [
    {
      "TotalItems": 1,
      "ItemsCompleted": 2,
      "Items": [
        {
          "Status": 0,
          "VillageId": "3574f2a3-16bc-4d91-b144-53c4c83eda7c",
          "Id": "c8d0fdd5-e32f-4653-bfd0-4e1d69ded932",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Url": "sample string 5",
          "Sequence": 6
        },
        {
          "Status": 0,
          "VillageId": "3574f2a3-16bc-4d91-b144-53c4c83eda7c",
          "Id": "c8d0fdd5-e32f-4653-bfd0-4e1d69ded932",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Url": "sample string 5",
          "Sequence": 6
        }
      ],
      "VillageId": "f9a7b983-684f-491c-8ed3-2513b2e20cc3",
      "Id": "26f1c8c7-c94a-418c-a508-f7e0272be761",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Url": "sample string 7",
      "Sequence": 8
    },
    {
      "TotalItems": 1,
      "ItemsCompleted": 2,
      "Items": [
        {
          "Status": 0,
          "VillageId": "3574f2a3-16bc-4d91-b144-53c4c83eda7c",
          "Id": "c8d0fdd5-e32f-4653-bfd0-4e1d69ded932",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Url": "sample string 5",
          "Sequence": 6
        },
        {
          "Status": 0,
          "VillageId": "3574f2a3-16bc-4d91-b144-53c4c83eda7c",
          "Id": "c8d0fdd5-e32f-4653-bfd0-4e1d69ded932",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Url": "sample string 5",
          "Sequence": 6
        }
      ],
      "VillageId": "f9a7b983-684f-491c-8ed3-2513b2e20cc3",
      "Id": "26f1c8c7-c94a-418c-a508-f7e0272be761",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Url": "sample string 7",
      "Sequence": 8
    }
  ],
  "VillageId": "d43dd348-4dc4-4a06-9869-c328828584cf",
  "Id": "d637a9d4-db3f-4993-abd6-3f8698976b21",
  "Name": "sample string 5",
  "Description": "sample string 6",
  "Url": "sample string 7",
  "Sequence": 8
}

application/xml, text/xml

Sample:

<VillageChecklistCategoryModel 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>d637a9d4-db3f-4993-abd6-3f8698976b21</Id>
  <Name>sample string 5</Name>
  <Sequence>8</Sequence>
  <Url>sample string 7</Url>
  <VillageId>d43dd348-4dc4-4a06-9869-c328828584cf</VillageId>
  <ItemsCompleted>2</ItemsCompleted>
  <Lists>
    <VillageChecklistModel>
      <Description>sample string 6</Description>
      <Id>26f1c8c7-c94a-418c-a508-f7e0272be761</Id>
      <Name>sample string 5</Name>
      <Sequence>8</Sequence>
      <Url>sample string 7</Url>
      <VillageId>f9a7b983-684f-491c-8ed3-2513b2e20cc3</VillageId>
      <Items>
        <VillageChecklistItemModel>
          <Description>sample string 4</Description>
          <Id>c8d0fdd5-e32f-4653-bfd0-4e1d69ded932</Id>
          <Name>sample string 3</Name>
          <Sequence>6</Sequence>
          <Url>sample string 5</Url>
          <VillageId>3574f2a3-16bc-4d91-b144-53c4c83eda7c</VillageId>
          <Status>NA</Status>
        </VillageChecklistItemModel>
        <VillageChecklistItemModel>
          <Description>sample string 4</Description>
          <Id>c8d0fdd5-e32f-4653-bfd0-4e1d69ded932</Id>
          <Name>sample string 3</Name>
          <Sequence>6</Sequence>
          <Url>sample string 5</Url>
          <VillageId>3574f2a3-16bc-4d91-b144-53c4c83eda7c</VillageId>
          <Status>NA</Status>
        </VillageChecklistItemModel>
      </Items>
      <ItemsCompleted>2</ItemsCompleted>
      <TotalItems>1</TotalItems>
    </VillageChecklistModel>
    <VillageChecklistModel>
      <Description>sample string 6</Description>
      <Id>26f1c8c7-c94a-418c-a508-f7e0272be761</Id>
      <Name>sample string 5</Name>
      <Sequence>8</Sequence>
      <Url>sample string 7</Url>
      <VillageId>f9a7b983-684f-491c-8ed3-2513b2e20cc3</VillageId>
      <Items>
        <VillageChecklistItemModel>
          <Description>sample string 4</Description>
          <Id>c8d0fdd5-e32f-4653-bfd0-4e1d69ded932</Id>
          <Name>sample string 3</Name>
          <Sequence>6</Sequence>
          <Url>sample string 5</Url>
          <VillageId>3574f2a3-16bc-4d91-b144-53c4c83eda7c</VillageId>
          <Status>NA</Status>
        </VillageChecklistItemModel>
        <VillageChecklistItemModel>
          <Description>sample string 4</Description>
          <Id>c8d0fdd5-e32f-4653-bfd0-4e1d69ded932</Id>
          <Name>sample string 3</Name>
          <Sequence>6</Sequence>
          <Url>sample string 5</Url>
          <VillageId>3574f2a3-16bc-4d91-b144-53c4c83eda7c</VillageId>
          <Status>NA</Status>
        </VillageChecklistItemModel>
      </Items>
      <ItemsCompleted>2</ItemsCompleted>
      <TotalItems>1</TotalItems>
    </VillageChecklistModel>
  </Lists>
  <TotalItems>1</TotalItems>
</VillageChecklistCategoryModel>