logo

Back to Help Home Page.

GET Api/Templates/Checklists

Retrieves a list of available checklists.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of checklists.

Collection of ChappReport.Site.Areas.Api.Models.V1.TemplateChecklistV1ModelResponse
NameDescriptionTypeAdditional information

Id

The id of the checklist

integer

None.

Modified

The last modification date of the checklist

date

None.

Labels

A list of labels per language.

Collection of ChappReport.Site.Areas.Api.Models.V1.TemplateChecklistV1ModelResponse+Label

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Modified": "2025-04-18T06:40:02",
    "Labels": [
      {
        "Language": "EN",
        "Value": "Villa",
        "Comment": "Additional information regarding the checklist."
      },
      {
        "Language": "NL",
        "Value": "Villa",
        "Comment": "Aanvullende informatie omtrent de checklist."
      }
    ]
  },
  {
    "Id": 2,
    "Modified": "2025-04-18T06:40:02",
    "Labels": [
      {
        "Language": "FR",
        "Value": "Studio"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfTemplateChecklistV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <TemplateChecklistV1ModelResponse>
    <Id>1</Id>
    <Labels>
      <TemplateChecklistV1ModelResponse.Label>
        <Comment>Additional information regarding the checklist.</Comment>
        <Language>EN</Language>
        <Value>Villa</Value>
      </TemplateChecklistV1ModelResponse.Label>
      <TemplateChecklistV1ModelResponse.Label>
        <Comment>Aanvullende informatie omtrent de checklist.</Comment>
        <Language>NL</Language>
        <Value>Villa</Value>
      </TemplateChecklistV1ModelResponse.Label>
    </Labels>
    <Modified>2025-04-18T06:40:02</Modified>
  </TemplateChecklistV1ModelResponse>
  <TemplateChecklistV1ModelResponse>
    <Id>2</Id>
    <Labels>
      <TemplateChecklistV1ModelResponse.Label>
        <Comment i:nil="true" />
        <Language>FR</Language>
        <Value>Studio</Value>
      </TemplateChecklistV1ModelResponse.Label>
    </Labels>
    <Modified>2025-04-18T06:40:02</Modified>
  </TemplateChecklistV1ModelResponse>
</ArrayOfTemplateChecklistV1ModelResponse>