Envios
Desassociar marcações do envio
Remover uma ou mais marcações de um envio
DELETE
/
api
/
v1
/
shipments
/
{id}
/
appointments
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]
Remove uma ou mais marcações deste envio. Ignora silenciosamente marcações que não estejam
atualmente associadas.
A regra de alteração é a mesma de Associar marcações a
envio: a associação pode ser removida quando
a colheita de sangue da marcação já ocorreu OU o envio foi criado há menos de 24 horas.
Pedido
Parâmetros de caminho
Parâmetros do corpo
Resposta
Em caso de sucesso, a API devolve200 OK com as marcações associadas no teu contexto de acesso,
com a associação mais antiga primeiro. Cada entrada tem a mesma estrutura de Obter marcação.
Respostas de erro
| Estado | Descrição |
|---|---|
400 | Erro de validação — p. ex., appointment_ids vazio ou UUID inválido. |
403 | Proibido — scope em falta, envio ou marcação fora do contexto de acesso, ou um pedido de kit para casa associado está fora do teu contexto de acesso. |
404 | Envio não encontrado, ou uma ou mais marcações não encontradas. |
409 | Falha na regra de alteração — pelo menos uma marcação não passou pela colheita de sangue e o envio tem mais de 24 horas. A resposta lista os IDs. |
500 | Erro interno do servidor. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"appointment_ids": [
"c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a"
]
}'
[]