DeaBooks

POST /DeaBooks/{id}/entries

Changed on

Request

Path parameters

idstring required

Request body

adjustInventoryboolean
containerIdstring
actionstring
containerStatusstring
patientIdstring nullable
witnessUserIdstring nullable
notesstring nullable
reasonstring nullable
correctedEntryIdstring nullable
expectedLatestEntryIdstring nullable

Optimistic token (ITE-1001): the id of the container's newest ledger entry as the user saw it when they opened the form. When present, the append is refused with 400 DEA_LEDGER_CHANGED if the (book, container) ledger has moved since. Optional and not persisted — omitting it keeps the previous, unchecked behavior.

collectorNamestring nullable

UK CDR: name of the person who collected the dispensed CD.

collectorIdCheckedboolean nullable

UK CDR: whether collector photo ID was verified.

entryDatestring date-time nullable

Response

OK

inventoryTransactionIdstring nullable
idstring
deaBookIdstring
containerIdstring
actionstring
containerStatusstring
patientIdstring nullable
userIdstring
witnessUserIdstring nullable
notesstring nullable
reasonstring nullable
correctedEntryIdstring nullable
collectorNamestring nullable

UK CDR: name of the person who collected the dispensed CD.

collectorIdCheckedboolean nullable

UK CDR: whether collector photo ID was verified.

quantityWordsAndFiguresstring nullable

UK CDR: quantity rendered in words + figures (CD Sched 2/3).

entryDatestring date-time
createdAtstring date-time

Changes

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)