Spring til hovedindhold
DELETE
Annuller en hjemmetestkitordre ved at sætte dens status til cancelled. Den annullerede hjemmetestkitordre returneres i svaret. Kun en ordre, der er pending, kan annulleres. Når den er dispatched, er kittet blevet pakket og mærket af distributionspartneren, og annullering returnerer 409 — det samme gør en ordre, der er activated. Hvis kittet allerede er bestilt hos distributionspartneren, annullerer vi det der, før vi annullerer dit, og kaldet fejler, hvis de ikke vil tage det tilbage: 409, når kittet allerede er pakket og mærket, og 502, når distributionspartneren afviste annulleringen eller ikke kunne kontaktes. Ved alle fejl ændres intet — ordren forbliver aktiv, og en 502 kan trygt prøves igen. Annullering af en ordre, der allerede er cancelled, returnerer 200 med den pågældende ordre, uanset hvilken status den blev annulleret fra. Svaret indeholder Idempotent-Replayed: true, så du kan skelne en gentagelse fra det kald, der udførte handlingen. Se Idempotens. Kræver scopet home_kit_orders_manage.

Forespørgsel

Stiparametre

string
påkrævet
Unikt id (UUID) for den hjemmetestkitordre, der skal annulleres.

Svar

Ved succes returnerer API’et 200 OK med den annullerede hjemmetestkitordre og dens indlejrede profil. En ordre, der allerede var annulleret, returnerer den samme 200.
string
påkrævet
Unikt id (UUID) for hjemmetestkitordren.
string
påkrævet
UUID for den profil, som denne hjemmetestkitordre tilhører.
string
påkrævet
Status for hjemmetestkitordren. Vil være cancelled efter en vellykket annullering.
object
påkrævet
Adressen, som kittet skal sendes til — i en af to former: enten { location_id }, der henviser til en kendt testlokation, eller de direkte adressefelter (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfri — samme feltnavne som i locations-API’et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge dele.
string
Laboratoriets prøvekode, som resultaterne rapporteres under — trykt på det fysiske kit, og det, patienten aflæser på æsken som aktiveringskode. null, indtil kittet er pakket. Skrivebeskyttet.
string
påkrævet
Prøvetagningstidspunkt rapporteret via Aktivér — hvornår patienten tog sin prøve. null, indtil kittet er aktiveret.
string
Den hjemmetestkitordre, som denne erstatter, når der er tale om et erstatningskit. null på en normal ordre. Se Opret hjemmetestkitordre.
string
Årsagen til, at erstatningen blev sendt. null på en normal ordre.
string[]
påkrævet
Adresser med små bogstaver, som hver modtager én e-mail, når alle laboratorieresultater er endelige. Tom, når funktionen er slået fra. Se E-mails når resultater er klar.
object
påkrævet
Partnerdefinerede nøgle/værdi-par, der returneres uændret. Altid til stede — {} når ikke angivet.
string
påkrævet
ISO 8601-tidsstempel for, hvornår hjemmetestkitordren blev oprettet.
string
ISO 8601-tidsstempel for den seneste opdatering. Kan være null.
object
påkrævet
Patientprofilen, der er knyttet til denne hjemmetestkitordre.
HomeKitOrderPanel[]
påkrævet
Det panel, der var tilknyttet denne hjemmetestkitordre før annulleringen — altid præcis ét (et hjemmetestkit svarer 1:1 til et fysisk kitprodukt). Slå paneldetaljer (navn, biomarkører) op via Vis paneler.
HomeKitOrderIndividualBiomarker[]
påkrævet
Enkeltstående biomarkører, der var tilknyttet denne hjemmetestkitordre før annulleringen. Slå hvert biomarker_id op i Vis biomarkører med home_kit=true for at få visningsdata.
HomeKitOrderShipmentLink[]
påkrævet
Pakker, der var knyttet til denne hjemmetestkitordre før annulleringen, med den ældste tilknytning først. Hent de komplette pakkeoplysninger med Vis forsendelser og ?home_kit_order_id=.

Fejlsvar