Saltar al contingut principal
DELETE
Cancel·la una comanda de kit de prova a casa establint el seu estat a cancelled. La resposta retorna la comanda de kit de prova a casa cancel·lada. Només es pot cancel·lar una comanda pending. Un cop està dispatched, el kit ja ha estat empaquetat i etiquetat per logística i cancel·lar retorna 409 — igual que amb una comanda activated. Si el kit ja s’ha demanat a logística, el cancel·lem allà abans de cancel·lar el teu, i la crida falla quan no n’accepten la cancel·lació: 409 quan el kit ja està empaquetat i etiquetat, 502 quan logística ha rebutjat la cancel·lació o no s’hi ha pogut contactar. En qualsevol cas d’error no es canvia res — la comanda continua activa i és segur tornar a intentar un 502. Cancel·lar una comanda que ja està cancelled retorna 200 amb aquella comanda, sigui quin sigui l’estat des del qual es va cancel·lar. La resposta inclou Idempotent-Replayed: true perquè puguis distingir una repetició de la crida que ha fet l’acció. Consulta Idempotència. Requereix l’àmbit home_kit_orders_manage.

Sol·licitud

Paràmetres de ruta

string
requerit
Identificador únic (UUID) de la comanda de kit de prova a casa que vols cancel·lar.

Resposta

Si té èxit, l’API retorna 200 OK amb la comanda de kit de prova a casa cancel·lada i el seu perfil incrustat. Una comanda que ja estava cancel·lada retorna el mateix 200.
string
requerit
Identificador únic de la comanda de kit de prova a casa (UUID).
string
requerit
UUID del perfil al qual pertany aquesta comanda de kit de prova a casa.
string
requerit
Estat de la comanda de kit de prova a casa. Serà cancelled després d’una cancel·lació correcta.
object
requerit
L’adreça on enviar el kit per correu — pot tenir dues formes: o bé { location_id }, que fa referència a una ubicació de prova coneguda, o bé els camps d’adreça directes (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionals — el mateix vocabulari que l’API d’ubicacions). Proporciona’n exactament una — una referència d’ubicació o una adreça directa, no pas totes dues.
string
Codi de mostra del laboratori amb què s’informen els resultats — imprès al kit físic, i el que el pacient llegeix de la caixa com a codi d’activació. null fins que el kit estigui empaquetat. Només de lectura.
string
requerit
Marca de temps de la recollida informada mitjançant Activa — quan el pacient va recollir la mostra. null fins que el kit estigui activat.
string
La comanda de kit de prova a casa que aquesta substitueix, quan és un kit de substitució. null en una comanda normal. Consulta Crea una comanda de kit de prova a casa.
string
Motiu pel qual s’ha enviat la substitució. null en una comanda normal.
string[]
requerit
Adreces que reben un correu electrònic cadascuna quan tots els resultats del laboratori són definitius, en minúscules. Buit quan està desactivat. Consulta Correus electrònics de resultats a punt.
object
requerit
Parells clau/valor definits pel col·laborador, retornats literalment. Sempre present — {} quan no s’ha definit.
string
requerit
Marca de temps ISO 8601 de quan es va crear la comanda de kit de prova a casa.
string
Marca de temps ISO 8601 de l’última actualització. Pot ser null.
object
requerit
El perfil del pacient associat a aquesta comanda de kit de prova a casa.
HomeKitOrderPanel[]
requerit
El panell que estava associat a aquesta comanda de kit de prova a casa abans de la cancel·lació — sempre exactament un (un kit de prova a casa té una correspondència 1:1 amb un producte de kit físic). Consulta els detalls del panell (nom, biomarcadors) mitjançant Llista panells.
HomeKitOrderIndividualBiomarker[]
requerit
Biomarcadors a la carta que estaven associats a aquesta comanda de kit de prova a casa abans de la cancel·lació. Consulta cada biomarker_id a Llista biomarcadors amb home_kit=true per obtenir les dades de visualització.
HomeKitOrderShipmentLink[]
requerit
Paquets que estaven vinculats a aquesta comanda de kit de prova a casa abans de la cancel·lació, començant pel vincle més antic. Llegeix els paquets complets amb Llista enviaments i ?home_kit_order_id=.

Respostes d’error