I 9 Add binary in fulfillment messages - UnionInternationalCheminsdeFer/OSDM GitHub Wiki
Description
Add binary in fulfillment messages.
Owner
- Dorsch Jessica (DB)
- Schinor Normen (DB)
- Bayer Ralf (DB)
Business Value
For customers
who do something
the solution
is a something – the ‘how’
that provides this value
unlike competitor, current solution or non-existing solution
our solution does something better — the ‘why’.
Business Outcomes
The measurable benefits that the business can anticipate if the epic hypothesis is proven to be correct.
Leading Indicators
The early measures that will help predict the business outcome hypothesis. For more on this topic, see the Innovation Accounting advanced topic article.
Nonfunctional Requirements
Nonfunctional requirements (NFRs) associated with the epic.
Context
Assumption is that even with the use of the documentLink
, this would point to a protected area that cannot be included into a website facing to the final customer
Idea
Modify the FulfillmentDocument
structure to add another attribute which can transport the fulfillment document in the same call and removes the need for an additional call via the document link, i.e.
FulfillmentDocument:
type: object
description: >-
document created for fulfillment. Providers should include either the link OR the content attributes
properties:
medium:
$ref: '#/components/schemas/FulfillmentMediaType'
type:
type: string
x-extensible-enum:
- BOOKING_RECEIPT
- TICKET
- BOARDING_PASS
- INFORMATION
- VOUCHER
link:
type: string
format: uri
content:
type: string
format: base64
description: >-
base64 encoded binary of the actual fulfillment document
format:
type: string
description: >-
physical format of the document provided via link or as binary content in Mime-Type format, e.g. application/pdf, image/jpeg etc.
Changes
- change 'documentType' to 'type' and 'documentLink' to 'link'
- add
content
andformat
attributes - modify description of overall object
Merged: https://github.com/UnionInternationalCheminsdeFer/OSDM/pull/147