Déclencher un accusé SCOR simulé

POST/v1/test-helpers/supporting-document-batches/{supportingDocumentBatch}/acknowledgment

Le simulateur écrit l’accusé du point d’accueil, qui suit le chemin d’un accusé déposé. scor_positive accuse le lot et ses pièces. scor_negative le refuse : 5100 sur l’entête (ses dossiers repartent dans un nouveau lot), 5999 sur les dossiers de dossiers (leurs pièces sont redemandées, les autres repartent). Un lot déjà réémis ne repart plus : ses pièces vont sur papier. Mode test seulement.

Droit de clé restreinte : batches:write.

Mode test seulement

Paramètres de chemin

supportingDocumentBatchtexteobligatoire
L'identifiant, sdb_….

Corps de la requête

scenarioénumérationobligatoire
scor_positive ou scor_negative.
scor_positivescor_negative
codeénumération
Le code d'un accusé négatif : 5100 refuse l'entête du lot (par défaut), 5999 refuse des dossiers.
51005999
dossierstableau de entier
Avec 5999, les dossiers refusés, par leur numéro dans le lot : le premier par défaut.

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet lots de pièces.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/test-helpers/supporting-document-batches/sdb_…/acknowledgment \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"scenario":"scor_negative","code":"5999","dossiers":[1]}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/test-helpers/supporting-document-batches/sdb_…/acknowledgment', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'scenario' => 'scor_negative',
        'code' => '5999',
        'dossiers' => [
            1,
        ],
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/test-helpers/supporting-document-batches/sdb_…/acknowledgment', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    scenario: 'scor_negative',
    code: '5999',
    dossiers: [
      1
    ]
  }),
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "supporting_document_batch",
  "status": "created",
  "name": "Accueil",
  "batch": null,
  "practitioner": "…",
  "sequence": 0,
  "sequence_count": 0,
  "dossier_count": 0,
  "document_count": 0,
  "recipient": null,
  "file_name": null,
  "size_bytes": null,
  "retransmission": true,
  "failure_code": null,
  "failure_label": null,
  "sent_at": null,
  "acknowledged_at": null,
  "failed_at": null,
  "livemode": false,
  "created": 1793970000
}