Skip to content

Exclui funcionários em lote

Request

Exclui vários funcionários em uma única requisição (até 100), reduzindo o número de chamadas frente ao limite de 60 requisições por minuto. Cada item da lista é o _id ou o external_id do funcionário. Diferente da exclusão individual, o header If-Match não é utilizado. Um funcionário excluído pode ser reativado depois com um PATCH /employees/{id} de corpo vazio.

Validação e resultado: a lista inteira é validada antes de qualquer exclusão, então se algum item for inválido a requisição falha com 422 e nenhum funcionário é excluído. Passada a validação, cada funcionário é excluído individualmente e a resposta 200 informa o resultado de cada um: os excluídos em successes e, em fails, os que não puderam ser excluídos com o motivo. A exclusão não é transacional, então um lote pode terminar parcialmente excluído — sempre confira fails e reenvie apenas esses itens.

Security
BasicAuth
Bodyapplication/json
employeesArray of strings, [ 1 .. 100 ] itemsrequired

Lista dos funcionários a excluir. O mesmo funcionário não pode ser informado duas vezes, nem por _id e external_id na mesma requisição.

Example:
[
  "5f3551beeb623e8ebe0ae994",
  "matricula-2231"
]
curl -i -X DELETE \
  -u '<username>:<password>' \
  https://api-docs.tiquetaque.app/_mock/employees/bulk \
  -H 'Content-Type: application/json' \
  -d '{
    "employees": [
      "5f3551beeb623e8ebe0ae994",
      "matricula-2231"
    ]
  }'

Responses

Lote processado. successes traz os funcionários excluídos e fails os que não puderam ser excluídos, com o motivo. Um fails não vazio significa exclusão parcial: os itens de successes já foram excluídos.

Bodyapplication/json
successesArray of objects
failsArray of objects
Response
{
  "successes": [
    { … },
    { … }
  ],
  "fails": []
}