API de listas de verificação

A API /checklists/ foi criada para permitir aos utilizadores transferir e analisar respostas a perguntas de listas de verificação no DISPATCH da L2L. Cada registo devolvido por esta API representa uma lista de verificação que foi criada a partir de uma Expedição, do Portal do Operador ou manualmente.

Filtrar listas de verificação

A API /checklists/ pode ser filtrada e ordenada por qualquer uma das propriedades principais, tais como: local, nome do documento, expedição, produto, linha, máquina, etc.

Perguntas e respostas

As Perguntas e respostas encontram-se nas propriedades tasks e answers, respetivamente.  

A lista tasks contém todas as perguntas que estavam na versão publicada da lista de verificação no momento em que esta foi criada. Se for publicada uma nova versão de uma lista de verificação e um utilizador optar por atualizar as perguntas da lista de verificação, a lista tasks também será atualizada na API.

A lista answers contém todas as respostas introduzidas na lista de verificação. Cada resposta tem uma propriedade task_number, que corresponde ao índice da pergunta na lista tasks à qual a resposta se refere. Por exemplo, se uma resposta tiver um task_number de 3, a pergunta relacionada é o terceiro item da lista tasks.

A API de respostas também inclui os critérios de aprovação, reprovação e aviso, caso esteja a utilizar a pontuação de listas de verificação. A API fornecerá um número: 0 = Aprovado, 1 = Aviso, 2 = Reprovado

 

Tabelas

As Perguntas e respostas de listas de verificação que se encontram dentro de tabelas também estão incluídas na API /checklists/. O objeto task define a tabela, incluindo os cabeçalhos das colunas, as informações das linhas e colunas e as definições das perguntas. As respostas estão incluídas na lista answers e a pergunta associada pode ser encontrada na lista tasks utilizando as propriedades task_number, table_row_number e table_column_number.

Considerações de desenvolvimento

• A propriedade task_hash no objeto da tarefa e no objeto da resposta existe por motivos relacionados com versões anteriores. Esta propriedade não deve ser utilizada para associar perguntas e respostas de tarefas.
• A API /checklistsanswers/ foi desenvolvida e lançada antes de as respostas serem incluídas no conteúdo da API /checklists/ e continuará a fornecer respostas no futuro. No entanto, o objeto de respostas no conteúdo da API /checklists/ é mais robusto e constitui o método preferencial para obter respostas de listas de verificação.