View / Create / Edit / Delete

Search checklists#

Searches checklists using flexible filters and returns basic information about each matching checklist — without categories, questions and attachments. Use this endpoint to quickly find the checklists you need and then request full data from the export endpoint below — /connector/rpc/checklist_export_with_photos — passing var_checklist_ids.

Deleted checklists are included in the search results. They are marked with deleted: true and have deleted_at / deleted_by filled. For deleted checklists var_last_modified_from / var_last_modified_to filter by the deletion date.

GET
/connector/rpc/checklist_search

Request parameters:

Request Parameter	Type	Description	Required
var_checklist_ids	Integer array	The array of checklist IDs. Make sure array braces {} are url encoded. Example: %7B97924,97925%7D	false
var_template_ids	Integer array	The array of checklist template IDs. Make sure array braces {} are url encoded.	false
var_division_ids	Integer array	The array of division IDs. Only checklists of stores that belong to these divisions are returned. Make sure array braces {} are url encoded.	false
var_region_ids	Integer array	The array of region IDs. Only checklists of stores that belong to these regions are returned. Make sure array braces {} are url encoded.	false
var_template_category_ids	Integer array	The array of template category IDs. Only checklists created from templates of these categories are returned. Make sure array braces {} are url encoded.	false
var_resolver_ids	Integer array	The array of resolver (user) IDs. Only checklists assigned to these users are returned. Make sure array braces {} are url encoded.	false
var_resolve_date_from	Timestamp without time zone	The start date for completing the checklist, formatted as a timestamp without a time zone. Example: 2024-05-21T00:00:00	false
var_resolve_date_to	Timestamp without time zone	The end date for completing the checklist, formatted as a timestamp without a time zone.	false
var_last_modified_from	Timestamp without time zone	The start date for the last modification of the checklist, formatted as a timestamp without a time zone.	false
var_last_modified_to	Timestamp without time zone	The end date for the last modification of the checklist, formatted as a timestamp without a time zone.	false

Examples

curl https://api.qvalon.com/v1/connector/rpc/checklist_search?var_last_modified_from=2024-05-21T00:00:00&var_last_modified_to=2024-05-22T00:00:00 \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "checklist_id": 97924,
    "last_modified": "2024-05-21T00:27:00.905924",
    "resolve_date": "2024-07-16",
    "checklist_status": "FIXED",
    "checklist_grade": 5,
    "checklist_percent_grade": 100,
    "template_id": 631,
    "template_name": "Daily Checklist",
    "shop_id": 664,
    "shop_sap": "351",
    "shop_locality": "Sample Store",
    "division_id": 28,
    "division_name": "United States",
    "resolver_id": 1658,
    "resolver_name": "Adam Smith",
    "deleted": false,
    "deleted_at": null,
    "deleted_by": null
  },
  {
    "checklist_id": 97812,
    "last_modified": "2024-05-10T09:12:44.12",
    "resolve_date": "2024-05-09",
    "checklist_status": "FIXED",
    "checklist_grade": 4.5,
    "checklist_percent_grade": 90,
    "template_id": 631,
    "template_name": "Daily Checklist",
    "shop_id": 671,
    "shop_sap": "352",
    "shop_locality": "Another Store",
    "division_id": 28,
    "division_name": "United States",
    "resolver_id": 1658,
    "resolver_name": "Adam Smith",
    "deleted": true,
    "deleted_at": "2024-05-21T10:15:00",
    "deleted_by": 1602
  }
]

Get checklists with questions and attachments#

Returns checklists matching the query params along with categories, questions, answers, photo attachments, linked form instances and custom fields.

Deleted checklists are included in the export. They are marked with deleted: true and have deleted_at / deleted_by filled. For deleted checklists var_last_modified_from / var_last_modified_to filter by the deletion date.
checklist_grade and checklist_percent_grade take approved appeals into account.
question_answer_text contains the answer as text: a grade for weighted templates, the name of the selected answer option for custom questions, or one of the predefined values Yes, No, Medium, Irrelevant, No answer. The predefined values are localized according to the default language of your system.
question_answer_source is bluetooth for answers received from a bluetooth device and manual otherwise.
All parameters are optional, but a request without any filter returns the whole checklist history of the tenant. The amount of data returned by this endpoint is usually quite large, so we strongly recommend limiting the export period with var_last_modified_from / var_last_modified_to as much as possible, or first finding the checklists you need with the lightweight Search checklists endpoint and then exporting them by var_checklist_ids.

GET
/connector/rpc/checklist_export_with_photos

Request parameters:

Request Parameter	Type	Description	Required
var_checklist_ids	Integer array	The array of checklist IDs you wish to export. Make sure array braces {} are url encoded. Example: %7B97924,97925%7D	false
var_template_ids	Integer array	The array of checklist template IDs. Make sure array braces {} are url encoded.	false
var_division_ids	Integer array	The array of division IDs. Only checklists of stores that belong to these divisions are returned. Make sure array braces {} are url encoded.	false
var_region_ids	Integer array	The array of region IDs. Only checklists of stores that belong to these regions are returned. Make sure array braces {} are url encoded.	false
var_template_category_ids	Integer array	The array of template category IDs. Only checklists created from templates of these categories are returned. Make sure array braces {} are url encoded.	false
var_resolver_ids	Integer array	The array of resolver (user) IDs. Only checklists assigned to these users are returned. Make sure array braces {} are url encoded.	false
var_resolve_date_from	Timestamp without time zone	The start date for completing the checklist, formatted as a timestamp without a time zone. Example: 2024-05-21T00:00:00	false
var_resolve_date_to	Timestamp without time zone	The end date for completing the checklist, formatted as a timestamp without a time zone.	false
var_last_modified_from	Timestamp without time zone	The start date for the last modification of the checklist, formatted as a timestamp without a time zone.	false
var_last_modified_to	Timestamp without time zone	The end date for the last modification of the checklist, formatted as a timestamp without a time zone.	false

Examples

curl https://api.qvalon.com/v1/connector/rpc/checklist_export_with_photos?var_checklist_ids=%7B97924%7D \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "checklist_id": 97924,
    "last_modified": "2024-05-21T00:27:00.905924",
    "resolve_date": "2024-07-16",
    "checklist_status": "FIXED",
    "checklist_start_time": "2024-05-21T12:03:06.87",
    "checklist_finish_time": "2024-05-21T20:26:54.434",
    "checklist_distance_in_meters": 18,
    "checklist_grade": 5,
    "checklist_percent_grade": 100,
    "checklist_result_text": null,
    "template_id": 631,
    "template_name": "Daily Checklist",
    "shop_id": 664,
    "shop_sap": "351",
    "shop_locality": "Sample Store",
    "cluster_id": 85,
    "cluster_name": "Los Angeles",
    "division_id": 28,
    "division_name": "United States",
    "resolver_id": 1658,
    "resolver_login": "sample@example.com",
    "resolver_name": "Adam Smith",
    "resolver_position": "Store Manager",
    "attributes": [
      {
        "attribute_id": 214,
        "schema_id": 12,
        "template_id": 631,
        "name": "Visit type",
        "required": true,
        "order_num": 1,
        "value_id": 45,
        "value": "Planned visit"
      }
    ],
    "categories": [
      {
        "questions": [
          {
            "answer_id": 359226,
            "question_id": 84512,
            "question_original_id": 84210,
            "question_name": "Please rate the cleanliness of the store.",
            "question_weight": 150,
            "days_for_action": 1,
            "question_result_grade": 750,
            "question_answer_text": "5",
            "question_answer_source": "manual",
            "question_changed_by_appeal": false,
            "need_correct": false,
            "comments_supervisor": "Cleaned during the visit",
            "comments_director": null,
            "comments_reviewer": null,
            "attachments": [
              {
                "url": "https://example.qvalon.com/files/s1/example/sample.jpg",
                "source": "CAMERA",
                "addedBy": "SUPERVISOR"
              }
            ],
            "form_instances": [
              {
                "form_instance_id": "b6d2c9a4-5e1f-4a3b-8c7d-512e9f4a6b02",
                "form_template_id": "a1e4f8b2-3c6d-4e1a-9f2b-77c5d8a1e001",
                "form_template_name": "Cleanliness issue report",
                "form_answers": [
                  {
                    "form_question_id": "c3f7a1d5-8b2e-4c9a-af6d-912b3e7c5a03",
                    "form_question_original_id": "d9a4e2c6-1f5b-4a8d-9e3c-903f6a2b8c04",
                    "form_question_name": "Describe the issue",
                    "form_question_type": "free",
                    "form_question_answers": null,
                    "form_question_file_answers": null,
                    "form_question_custom_answer": "Dust on the top shelves",
                    "form_question_comment": null,
                    "update_at": "2024-05-21T12:10:02.15"
                  }
                ]
              }
            ],
            "fields": {
              "severity": [
                {
                  "value": "HIGH",
                  "catalog_value_id": 204,
                  "catalog_value_external_id": "SEV-1"
                }
              ]
            },
            "answered_at": "2024-05-21T12:05:11.437",
            "answered_at_offset": "3"
          },
          {
            "answer_id": 359252,
            "question_id": 84513,
            "question_original_id": 84211,
            "question_name": "All trade equipment is in working condition.",
            "question_weight": 150,
            "days_for_action": 1,
            "question_result_grade": 750,
            "question_answer_text": "Yes",
            "question_answer_source": "manual",
            "question_changed_by_appeal": false,
            "need_correct": false,
            "comments_supervisor": null,
            "comments_director": null,
            "comments_reviewer": null,
            "attachments": {},
            "form_instances": {},
            "fields": {},
            "answered_at": "2024-05-21T12:07:43.112",
            "answered_at_offset": "3"
          }
        ],
        "category_id": 4132,
        "category_name": "Main process",
        "category_grade": 5,
        "category_max_grade": 5,
        "category_result_text": "Passed",
        "category_percent_grade": 100
      }
    ],
    "custom_data": null,
    "deleted": false,
    "deleted_at": null,
    "deleted_by": null
  }
]

Create checklists#

Accepts an array of checklists to create and returns the list of created Checklist objects.

Date fields in the response are returned as epoch milliseconds, except lastModifiedAt, which is returned as epoch seconds.
countAnswerIsNo and countAnswerNoSave in the response are legacy names kept for backward compatibility: they contain the number of answers left to fix and the number of fixed answers.
By default, only one checklist with the same template, store, resolver and plan date can be created — an attempt to create a duplicate returns a validation error. This can be changed by your administrator with the "Allow conducting multiple inspections per day using the same template" option in Administration → Inspections.

POST
/checklist/create

Request body:

Attribute	Type	Description	Nullable
resolverId	Integer	Identifier of resolver	false
shopId	Integer	Identifier of store	false
templateId	Integer	Identifier of template	false
resolveDate	Date	Plan date in YYYY-MM-DD format	false
resolverIds	Integer array	Identifiers of resolvers. Use together with withManyResolvers: true to assign the checklist to several users at once (instead of resolverId)	true
withManyResolvers	Boolean	Set to true to assign the checklist to several resolvers listed in resolverIds. Default: false	true
needReview	Boolean	If true, the checklist requires review after completion. Only applies when the template allows overriding its review settings; otherwise the template setting is used	true
visibleFromDate	Date	The date from which the checklist becomes visible to the resolver	true

Examples

curl --request POST https://api.qvalon.com/v1/checklist/create \
--header 'Authorization: Bearer <your_token>' \
-d '[{"resolverId":1602,"shopId":669,"templateId":629,"resolveDate":"2022-06-07"}]'

200 OK

[
  {
    "id": 92803,
    "templateId": 629,
    "resolverId": 1602,
    "resolveDate": 1654560000000,
    "finishDate": null,
    "shopLocality": "Shoes shop",
    "shopSap": "111",
    "shopLatitude": null,
    "shopLongitude": null,
    "shopId": 669,
    "templateName": "Shoes sizes",
    "shopName": "Shoes shop",
    "grade": 0,
    "newGrade": null,
    "statusName": "PLANNING",
    "resolverFio": "Mason Mount",
    "resolverRole": "Region manager",
    "comment": null,
    "lastModifiedAt": 1654585502,
    "templateCategoryId": null,
    "templateCategoryName": null,
    "incidentsAmount": "",
    "fixedIncidentsAmount": "",
    "duration": "",
    "type": "unplan",
    "displayStatusName": "Planned",
    "needReview": false,
    "inReview": false,
    "reviewerId": null,
    "startDate": null,
    "countAnswerIsNo": 0,
    "countAnswerNoSave": 0,
    "actualFinishDate": 1654560000000
  }
]

Delete checklist by id#

Delete checklist by id

DELETE
/checklist/{id}

Examples

curl --request DELETE https://api.qvalon.com/v1/checklist/92803 \
--header 'Authorization: Bearer <your_token>'

200 OK

{}