View / Create / Edit / Delete

Get checklist by id#

Return Checklist object

GET
/objects/checklists/{id}

Examples

curl https://api.qvalon.com/v1/objects/checklists/92803 \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "id": 92803,
    "templateId": 629,
    "resolverId": 1602,
    "resolveDate": 1654560000000,
    "finishDate": null,
    "shopLocality": "Basketball shop",
    "shopSap": "111",
    "shopLatitude": null,
    "shopLongitude": null,
    "shopId": 669,
    "templateName": "Equipment",
    "shopName": "Basketball shop",
    "grade": 0,
    "newGrade": null,
    "statusName": "PLANNING",
    "resolverFio": "Lebron James",
    "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
  }
]

Get checklists with questions and attachments#

Returns checklists matching the query params alongside with questions and attachments.

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.	false
var_template_ids	Integer array	The array of checklist template IDs. 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.	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 \
--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": null,
    "categories": [
      {
        "questions": [
          {
            "answer_id": 359226,
            "attachments": [
              {
                "url": "https://example.qvalon.com/files/s1/example/sample.jpg",
                "source": "CAMERA",
                "addedBy": "SUPERVISOR"
              }
            ],
            "question_name": "Please rate the cleanliness of the store.",
            "days_for_action": 1,
            "question_weight": 150,
            "comments_director": null,
            "comments_reviewer": null,
            "comments_supervisor": null,
            "question_answer_text": "5",
            "question_result_grade": 750
          },
          {
            "answer_id": 359252,
            "attachments": [
              {
                "url": "https://example.qvalon.com/files/s1/example/sample2.jpg",
                "source": "CAMERA",
                "addedBy": "SUPERVISOR"
              }
            ],
            "question_name": "All trade equipment is in working condition.",
            "days_for_action": 1,
            "question_weight": 150,
            "comments_director": null,
            "comments_reviewer": null,
            "comments_supervisor": null,
            "question_answer_text": "Yes",
            "question_result_grade": 750
          }
        ],
        "category_id": 4132,
        "category_name": "Main process",
        "category_grade": 5,
        "category_max_grade": 5,
        "category_result_text": "Passed",
        "category_percent_grade": 100
      }
    ]
  }
]

Create checklists#

Return list of Checklist objects

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	false

Examples

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

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/id?hint=simple text hint \
--header 'Authorization: Bearer <your_token>'

200 OK

{}

Get checklists ids#

Get checklists ids by template id.

GET
/checklist/find

Request parameters:

Request Parameter	Type	Description	Required
templateId	Integer	Identifier of checklist template	false
shopId	Integer	Identifier of shop	false
fromDate	ISO DateTime	Date & Time in ISO DateTime format. Example: 2024-01-01T00:00:00.000Z	false
toDate	ISO DateTime	Date & Time in ISO DateTime format. Example: 2024-01-01T00:00:00.000Z	false

Response

Returns an array of checklsit IDs

Examples

curl https://api.qvalon.com/v1/checklist/find \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json'

200 OK

Get available checklists for user#

Get available checklists for user by user id.

GET
/checklist/getAvailableChecklists

Request parameters:

Request Parameter	Type	Description	Required
userId	Integer	Identifier of user	true

Response

Returns a list of Checklists

Examples

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

200 OK

[
  {
    "id": 92999,
    "comment": null,
    "numberFixedAnswers": 0,
    "numberToFixAnswers": 0,
    "resolverId": 1,
    "lastModifiedAt": 1656893482133,
    "resolveDate": "2022-07-03",
    "finishDate": null,
    "statusName": "MISSED",
    "grade": 0,
    "percentGrade": null,
    "newGrade": null,
    "newPercentGrade": null,
    "resolvedIp": null,
    "matchedWithRealIp": null,
    "answers": [],
    "startLongitude": null,
    "startLatitude": null,
    "endLongitude": null,
    "endLatitude": null,
    "matchedWithCoor": null,
    "distanceInMeters": null,
    "type": "unplan",
    "fillupType": null,
    "startTime": 1656857669437,
    "startTimeOffset": "3",
    "finishTimeOffset": null,
    "createDate": null,
    "closedBySystem": null,
    "needReview": false,
    "inReview": false,
    "reviewerIds": [],
    "ruleId": null,
    "authorId": 1,
    "naMode": null,
    "finishDateInUTC": null,
    "startTimeInUTC": "2022-07-03T14:14:29.437Z",
    "templateName": "Milk delivery",
    "actualFinishDate": "2022-07-03T00:00:00.000Z"
  }
]