GET api/Checklists/All

Return all checklists in all categories for this village (full data dump)

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ChecklistCategoryMetadataModel
NameDescriptionTypeAdditional information
TotalItems

Sum of items across all checklists in this category

integer

None.

Lists

List of checklists in this category

Collection of ChecklistMetadataModel

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,
    "Lists": [
      {
        "TotalItems": 1,
        "Items": [
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          },
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          }
        ],
        "Id": "a95c3407-4450-475c-bcc4-bc956af6913f",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Url": "sample string 5",
        "Sequence": 6
      },
      {
        "TotalItems": 1,
        "Items": [
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          },
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          }
        ],
        "Id": "a95c3407-4450-475c-bcc4-bc956af6913f",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Url": "sample string 5",
        "Sequence": 6
      }
    ],
    "Id": "cd57accc-7c10-4ff5-9470-442cf9778e53",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Url": "sample string 5",
    "Sequence": 6
  },
  {
    "TotalItems": 1,
    "Lists": [
      {
        "TotalItems": 1,
        "Items": [
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          },
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          }
        ],
        "Id": "a95c3407-4450-475c-bcc4-bc956af6913f",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Url": "sample string 5",
        "Sequence": 6
      },
      {
        "TotalItems": 1,
        "Items": [
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          },
          {
            "Id": "9a2e2751-3737-403a-96e5-e12c65044a61",
            "Name": "sample string 2",
            "Description": "sample string 3",
            "Url": "sample string 4",
            "Sequence": 5
          }
        ],
        "Id": "a95c3407-4450-475c-bcc4-bc956af6913f",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Url": "sample string 5",
        "Sequence": 6
      }
    ],
    "Id": "cd57accc-7c10-4ff5-9470-442cf9778e53",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Url": "sample string 5",
    "Sequence": 6
  }
]

application/xml, text/xml

Sample:
<ArrayOfChecklistCategoryMetadataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <ChecklistCategoryMetadataModel>
    <Description>sample string 4</Description>
    <Id>cd57accc-7c10-4ff5-9470-442cf9778e53</Id>
    <Name>sample string 3</Name>
    <Sequence>6</Sequence>
    <Url>sample string 5</Url>
    <Lists>
      <ChecklistMetadataModel>
        <Description>sample string 4</Description>
        <Id>a95c3407-4450-475c-bcc4-bc956af6913f</Id>
        <Name>sample string 3</Name>
        <Sequence>6</Sequence>
        <Url>sample string 5</Url>
        <Items>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
        </Items>
        <TotalItems>1</TotalItems>
      </ChecklistMetadataModel>
      <ChecklistMetadataModel>
        <Description>sample string 4</Description>
        <Id>a95c3407-4450-475c-bcc4-bc956af6913f</Id>
        <Name>sample string 3</Name>
        <Sequence>6</Sequence>
        <Url>sample string 5</Url>
        <Items>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
        </Items>
        <TotalItems>1</TotalItems>
      </ChecklistMetadataModel>
    </Lists>
    <TotalItems>1</TotalItems>
  </ChecklistCategoryMetadataModel>
  <ChecklistCategoryMetadataModel>
    <Description>sample string 4</Description>
    <Id>cd57accc-7c10-4ff5-9470-442cf9778e53</Id>
    <Name>sample string 3</Name>
    <Sequence>6</Sequence>
    <Url>sample string 5</Url>
    <Lists>
      <ChecklistMetadataModel>
        <Description>sample string 4</Description>
        <Id>a95c3407-4450-475c-bcc4-bc956af6913f</Id>
        <Name>sample string 3</Name>
        <Sequence>6</Sequence>
        <Url>sample string 5</Url>
        <Items>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
        </Items>
        <TotalItems>1</TotalItems>
      </ChecklistMetadataModel>
      <ChecklistMetadataModel>
        <Description>sample string 4</Description>
        <Id>a95c3407-4450-475c-bcc4-bc956af6913f</Id>
        <Name>sample string 3</Name>
        <Sequence>6</Sequence>
        <Url>sample string 5</Url>
        <Items>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
          <ChecklistItemMetadataModel>
            <Description>sample string 3</Description>
            <Id>9a2e2751-3737-403a-96e5-e12c65044a61</Id>
            <Name>sample string 2</Name>
            <Sequence>5</Sequence>
            <Url>sample string 4</Url>
          </ChecklistItemMetadataModel>
        </Items>
        <TotalItems>1</TotalItems>
      </ChecklistMetadataModel>
    </Lists>
    <TotalItems>1</TotalItems>
  </ChecklistCategoryMetadataModel>
</ArrayOfChecklistCategoryMetadataModel>