Мобильные
сотрудники
Справочный
центр

ИнтеграцияИнтеграция по APIРабота с чек-листами

Работа с чек-листами

Получение шаблонов чек-листов

Общее описание

Функция GET /v6/api/checklistManagement/templates позволяет получить список шаблонов чек-листов.

Параметры вызова

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает массив структур с параметрами шаблонов чек-листов:

Параметр Описание
checklistTemplateID ИД шаблона чек-листа
name Название шаблона чек-листа
description Описание шаблона чек-листа

Формат запроса

GET /v6/api/checklistManagement/templates HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/checklistManagement/templates HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "checklistTemplateID": 0,
        "name": "string",
        "description": "string"
    },
    \{
        "checklistTemplateID": 0,
        "name": "string",
        "description": "string"
    }
]

Пример ответа

[
    \{
        "checklistTemplateID": 1,
        "name": "Техническое обслуживание лифта",
        "description": "Чек-лист технического обслуживания лифта OTIS"
    },
    \{
        "checklistTemplateID": 2,
        "name": "Техническое обслуживание дома",
        "description": "Чек-лист технического обслуживания 10-этажного дома"
    }
]

Получение списка чек-листов

Общее описание

Функция GET /v6/api/checklistManagement/checklists?dateFrom={date-time}&dateTo={date-time}&subscriberIDs={long}&taskIDs={long} позволяет получить список чек-листов.

Параметры вызова

Функция имеет следующие параметры:

Параметр Описание
dateFrom Дата, время начала периода для получения заполненных чек-листов (подробнее о формате времени).
dateTo Дата, время окончания периода для получения заполненных чек-листов (подробнее о формате времени).
subscriberIDs ИД Сотрудников (необязательное поле). Подробнее о передаче нескольких идентификаторов
taskIDs ИД задач (необязательное поле). Подробнее о передаче нескольких идентификаторов

Результат выполнения

Функция возвращает массив структур с параметрами чек-листов:

Параметр Описание
checklistID ИД чек-листа
assetID ИД актива
name Название чек-листа
description Описание чек-листа
isRequired Является ли заполнение чек-листа обязательным. Существуют следующие значения: true — заполнение чек-листа является обязательным; false — заполнение чек-листа не обязательно.
checkListExternalID Внешний ИД чек-листа
type Тип чек-листа. Существуют следующие значения: 0 — тип по умолчанию.
status Статус чек-листа. Существуют следующие значения: 0 — новый; 1 — черновик; 2 — пройден.
creationDate Дата и время создания чек-листа
taskID ИД задачи, к которой привязан чек-лист
lastModificationDate Дата и время последнего прохождения чек-листа
subscriberID ИД Сотрудника, который заполняет чек-лист
latitude Географическая широта места прохождения чек-листа (в градусах)
longitude Географическая долгота места прохождения чек-листа (в градусах)
radius Радиус погрешности определения места прохождения чек-листа (в метрах)
address Адрес прохождения чек-листа
checkListTemplateIDs ИД шаблонов чек-листов
checkListTemplateNames Названия шаблонов чек-листов
maxScore Максимальная оценка по итогам прохождения чек-листа
totalScore Общая оценка по итогам прохождения чек-листа

Формат запроса

GET /v6/api/checklistManagement/checklists?dateFrom=\{date-time}&dateTo=\{date-time}&subscriberIDs=\{long}&taskIDs=\{long} HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/checklistManagement/checklists?dateFrom=\{date-time}&dateTo=\{date-time}&subscriberIDs=\{long}&taskIDs=\{long} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
  \{
    "checklistID": integer,
    "assetID": integer,
    "name": "string",
    "description": "string",
    "isRequired": boolean,
    "checkListExternalID": "string",
    "type": integer,
    "status": integer,
    "creationDate": "date-time",
    "taskID": integer,
    "lastModificationDate": "date-time",
    "subscriberID": integer,
    "latitude": number,
    "longitude": number,
    "radius": integer,
    "address": "string",
    "checkListTemplateIDs": [
      integer
    ],
    "checkListTemplateNames": [
      "string"
    ],
    "maxScore": number,
    "totalScore": number
  },
  \{
    "checklistID": integer,
    "assetID": integer,
    "name": "string",
    "description": "string",
    "isRequired": boolean,
    "checkListExternalID": "string",
    "type": integer,
    "status": integer,
    "creationDate": "date-time",
    "taskID": integer,
    "lastModificationDate": "date-time",
    "subscriberID": integer,
    "latitude": number,
    "longitude": number,
    "radius": integer,
    "address": "string",
    "checkListTemplateIDs": [
      integer
    ],
    "checkListTemplateNames": [
      "string"
    ],
    "maxScore": number,
    "totalScore": number
  }
]

Пример ответа

[
  \{
    "checklistID": 1,
    "name": "Тех. Обслуживание помещения",
    "isRequired": false,
    "checkListExternalID": "6093f666-97db-4722-9bd0-4c9d9ab480e7",
    "type": 0,
    "status": 0,
    "creationDate": "2023-07-03T10:29:38.347+03:00",
    "taskID": 1,
    "checkListTemplateIDs": [
      1
    ],
    "checkListTemplateNames": [
      "Шаблон чек-листа помещения"
    ]
  },
  \{
    "checklistID": 61,
    "name": "Техническое обслуживание лифта",
    "isRequired": false,
    "checkListExternalID": "3977799a-15ce-4161-80a0-8a35c569c523",
    "type": 0,
    "status": 2,
    "creationDate": "2023-07-06T11:20:10.22+03:00",
    "taskID": 2,
    "lastModificationDate": "2023-06-19T21:12:45.83+03:00",
    "subscriberID": 2,
    "latitude": 55.737278,
    "longitude": 37.501623,
    "radius": 4,
    "address": "г. Москва, улица Василисы Кожиной, 8к2",
    "checkListTemplateIDs": [
      2
    ],
    "checkListTemplateNames": [
      "Лифт"
    ],
    "totalScore": 0
  }
]

Получение чек-листа

Общее описание

Функция GET /v6/api/checklistManagement/checklists/{checklistID} позволяет получить чек-лист по его идентификатору.

Параметры вызова

В запросе используется обязательный параметр checklistID — ИД чек-листа.

Результат выполнения

Функция возвращает массив структур с параметрами шаблонов чек-листов:

Параметр Описание
checklistID ИД чек-листа
assetID ИД актива
name Название чек-листа
description Описание чек-листа
isRequired Является ли заполнение чек-листа обязательным. Существуют следующие значения:
  • true — заполнение чек-листа является обязательным;
  • false — заполнение чек-листа не обязательно.
checkListExternalID Внешний ИД чек-листа
type Тип чек-листа. Существуют следующие значения: 0 — тип по умолчанию.
Status Статус чек-листа. Существуют следующие значения: 0 — новый; 1 — черновик; 2 — пройден.
creationDate Дата и время создания чек-листа
taskID ИД задачи, к которой привязан чек-лист
lastModificationDate Дата и время последнего прохождения чек-листа
subscriberID ИД Сотрудника, который заполняет чек-лист
latitude Географическая широта места прохождения чек-листа (в градусах)
longitude Географическая долгота места прохождения чек-листа (в градусах)
radius Радиус погрешности определения места прохождения чек-листа (в метрах)
address Адрес прохождения чек-листа
checkListTemplateIDs ИД шаблонов чек-листов
checkListTemplateNames Названия шаблонов чек-листов
maxScore Максимальная оценка по итогам прохождения чек-листа
totalScore Общая оценка по итогам прохождения чек-листа
Параметры разделов (массив структур sections)
title Название раздела
Параметры блоков (массив структур blocks)
title Название блока
Параметры полей (массив структур values)
externalID Внешний ИД поля
name Название поля
value Значения поля
type Тип поля. Существуют следующие значения 0 — строка; 1 — текст; 2 — дата; 3 — время; 4 — целое число; 5 — вещественное число; 6 — галочка; 7 — список; 8 — изображение; 9 — файл; 10 — информация; 11 — таблица.

Формат запроса

GET /v6/api/checklistManagement/checklists/\{checklistID} HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/checklistManagement/checklists/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "checklistID": integer,
    "assetID": integer,
    "name": "string",
    "description": "string",
    "isRequired": boolean,
    "checkListExternalID": "string",
    "type": integer,
    "status": integer,
    "creationDate": "date-time",
    "taskID": integer,
    "lastModificationDate": "date-time",
    "subscriberID": integer,
    "latitude": number,
    "longitude": number,
    "radius": integer,
    "address": "string",
    "checkListTemplateIDs": [
        integer
    ],
    "checkListTemplateNames": [
        integer
    ],
    "maxScore": integer,
    "totalScore": integer,
    "sections": [
        \{
            "title": "string",
            "blocks": [
                \{
                    "title": "string",
                    "values": [
                        \{
                            "externalID": "string",
                            "name": "string",
                            "value": "string",
                            "type": "string"
                        \{
                            "externalID": "string",
                            "name": "string",
                            "value": "string",
                            "type": "string"
                        }
                    ]
                },
                \{
                    "title": "string",
                    "values": [
                        \{
                            "externalID": "string",
                            "name": "string",
                            "value": "string",
                            "type": "string"
                        },
                        \{
                            "externalID": "string",
                            "name": "string",
                            "value": "string",
                            "type": "string"
                        }
                    ]
                }
            ]
        }
    ]
}

Пример ответа

\{
    "checklistID": 1,
    "name": "Обслуживание кофемашины",
    "description": "Проверить полностью",
    "isRequired": false,
    "checkListExternalID": "616149fd-4fd5-4ab5-841f-d01f26f8cb6b",
    "type": 0,
    "status": 2,
    "creationDate": "2023-06-19T21:10:39.94+03:00",
    "taskID": 2,
    "lastModificationDate": "2023-06-19T21:12:45.83+03:00",
    "subscriberID": 2,
    "latitude": 55.737278,
    "longitude": 37.501623,
    "radius": 4,
    "address": "г. Москва, улица Василисы Кожиной, 8к2",
    "checkListTemplateIDs": [
        3
    ],
    "checkListTemplateNames": [
        "кофемашина"
    ],
    "totalScore": 0,
    "sections": [
        \{
            "title": "Химическая чистка кофейного тракта:",
            "blocks": [
                \{
                    "title": "Подготовка к процессу",
                    "values": [
                        \{
                            "externalID": "882127c2-325d-4dbc-bdb4-56cbca2e6b5e",
                            "name": "Чтобы правильно выполнить этот блок необходимо ознакомиться с инструкцией",
                            "type": "10"
                        },
                        \{
                            "externalID": "6762615f-0b2f-44c7-958a-e6a11456a014",
                            "name": "Заполните контейнер для раствора чистящего средства",
                            "value": "Нет",
                            "type": "6"
                        },
                        \{
                            "externalID": "d94bc1d1-157f-4f7e-94ee-005f45f566d7",
                            "name": "Подготовьте чистящий порошок или таблетки для кофемашины",
                            "value": "Нет",
                            "type": "6"
                        }
                    ]
                },
                \{
                    "title": "Запуск процесса чистки:",
                    "values": [
                        \{
                            "externalID": "1f8580a4-37f7-4042-bae0-ca737ac79a70",
                            "name": "Запустите программу чистки кофейного тракта в соответствии с инструкцией производителя.",
                            "value": "Да",
                            "type": "6"
                        },
                        \{
                            "externalID": "5424ea5e-bf42-4de9-93da-bf4733436601",
                            "name": "Включите кофемашину и дождитесь, пока она нагреется",
                            "value": "Нет",
                            "type": "6"
                        },
                        \{
                            "externalID": "d9da505f-0bb6-471f-95ad-bcc244f4a99e",
                            "name": "Убедитесь, что чистящее растворение проходит через все компоненты кофейного тракта.",
                            "value": "Нет",
                            "type": "6"
                        }
                    ]
                },
                \{
                    "title": "Завершение процесса",
                    "values": [
                        \{
                            "externalID": "da8fbcbf-da36-4ab9-b404-78102f6d630b",
                            "name": "Запишите результаты чистки кофейного тракта.",
                            "value": "Да",
                            "type": "6"
                        }
                    ]
                }
            ]
        }
    ]
}

Работа с формами

Предыдущая страница

Работа со справочниками

Следующая страница

Содержание

Получение шаблонов чек-листовПолучение списка чек-листовПолучение чек-листа