POST/api/v1/s2s/partners/settings-copy/apply

Apply partner pharmacy settings copy

Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.9.0-Vertrag.

Übersicht

Nutzen Sie den Endpunkt ausschließlich mit einem Partner-API-Schlüssel. Die Codebeispiele verwenden Platzhalter und die öffentliche Sandbox-Adresse.

Methode: POST
Endpunkt: /api/v1/s2s/partners/settings-copy/apply
Authentifizierung: X-API-Key

Anfrage

Parameter

X-Correlation-IDstringheader: Optional opaque request correlation ID for tracing API calls across systems. Billing audit paths persist only UUIDv4-shaped values and drop free-form values.; Beispiel: 33333333-3333-4333-8333-333333333333
Idempotency-KeystringheaderErforderlich: Required opaque retry key. Reuse the identical key only for an explicit retry of the identical canonical Apply request.; Beispiel: settings-copy-01

Request-Body

Erforderlich

appointmentTypePairsarray: Explicit appointment-type pairs. Source IDs may repeat; target IDs must be unique.
appointmentTypePairs[].sourceAppointmentTypeIdstring (uuid)Erforderlich: Active appointment type in the source pharmacy.; Beispiel: 10000000-0000-4000-8000-000000000005
appointmentTypePairs[].targetAppointmentTypeIdstring (uuid)Erforderlich: Active appointment type in the target pharmacy. Must be unique within the request.; Beispiel: 10000000-0000-4000-8000-000000000006
previewRevisionstringErforderlich: Opaque value-free revision returned by Preview. It is bound to selectors, pairs, strategy and current copyable state.; Beispiel: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
reasonstringErforderlich: Required trimmed PHI-free justification. It is never stored, returned, logged or projected into audit metadata; audit records reasonProvided only.; Beispiel: Konfiguration abgestimmt.
sourcePartnerOrgIdstringErforderlich: Partner-owned source pharmacy selector.; Beispiel: synthetic-source-01
strategystringErforderlich: Conflict strategy. OVERWRITE_CONFLICTS requires a fresh Preview generated for that strategy.; Beispiel: FAIL_ON_CONFLICT
targetPartnerOrgIdstringErforderlich: Partner-owned target pharmacy selector.; Beispiel: synthetic-target-01

Vertrag

Der versionierte OpenAPI-Vertrag ist die verbindliche Quelle für Parameter, Request-Body und Response-Schemas.

Version

1.9.0

Erwartete Antwort

201 Created

OpenAPI 1.9.0 herunterladen

Simulierte Sandbox

Sprache

cURL

curl --request POST \
  --url https://sandbox.arztkonsultation.io/api/v1/s2s/partners/settings-copy/apply \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}' \
  --data '{"appointmentTypePairs":[{"sourceAppointmentTypeId":"10000000-0000-4000-8000-000000000005","targetAppointmentTypeId":"10000000-0000-4000-8000-000000000006"}],"previewRevision":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","reason":"Konfiguration abgestimmt.","sourcePartnerOrgId":"synthetic-source-01","strategy":"FAIL_ON_CONFLICT","targetPartnerOrgId":"synthetic-target-01"}'

Antwortszenario