HumanTrackDevelopers
Referência da APIAplicações

Cancelar aplicações de um instrumento para o paciente

POST/professionals/{professionalId}/patients/{patientId}/forms/{formId}/applications/cancel

Encerra de uma vez todas as aplicações ativas de um instrumento para o paciente. Cada aplicação encerrada passa a FINISHED e suas submissões pendentes são canceladas. Aplicações já finalizadas ou canceladas são ignoradas, então a chamada é idempotente.

Autorização

ApiKey ApiSecret
X-Api-Key<token>

API Key do parceiro. Deve ser enviada junto com X-Api-Secret.

Em: header

X-Api-Secret<token>

API Secret do parceiro. Deve ser enviada junto com X-Api-Key.

Em: header

Parâmetros de path

professionalId*string

ID do profissional na HumanTrack (humanTrackId).

Formatouuid
patientId*string

ID do paciente na HumanTrack (humanTrackId).

Formatouuid
formId*string

ID do instrumento.

Formatouuid

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/professionals/3f7c1a54-6b2e-4a1d-8f0c-2b5e9d3a7c11/patients/9d2e4b70-1c3a-4f6e-9b8d-5a7c0e2f4d33/forms/b1e7d9c2-4f3a-4d8e-9c1b-7a2e5f0d6c88/applications/cancel"
{  "canceledApplicationIds": [    0  ],  "canceledCount": 0}