A subscription message object description.
This integration follows the EVENT/COMMAND pattern. The OpCo is considered as the owner of the SoR (system of records), therefore sending EVENTS. All other systems are considered as SoE (systems of engagement) and send COMMANDS. For the moment COMMANDS are not supported.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"SUBSCRIPTION"
"SUBSCRIPTION"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"SUBSCRIPTION_GROUP"
"SUBSCRIPTION_GROUP"
The event message header providing metadata details.
No Additional PropertiesThe source entity of this event
"OPCO"
The version of the json event format
"v1"
The type of the event following the command/event pattern.
At the moment Spark will not allow any modification/creation/deletion of subscriptions types and groups, Spark will only consume the EVENT coming from the OpCo.
"EVENT"
This object is used to describe the type of the subscription
- SUBSCRIPTION is a single subscription
- SUBSCRIPTION_GROUP is a group of subscriptions
"SUBSCRIPTION"
This object contains the actual data of the subscription event
No Additional PropertiesIf the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"SUBSCRIPTION_GROUP"
The code of the subscription/group (logical identifier)
Must be at least 1 characters long
"INVOICE_NOTIFICATION"
This filed should contain the label of the subscription (i18n field)
{
"fr-FR": "Notification sur les factures",
"en-GB": "Invoices notification"
}
Each additional property must conform to the following schema
Type: stringMust be at least 1 characters long
A short description of the subscription
{
"fr-FR": "Recevoir une notification à chaque nouvelle facture",
"en-GB": "Receive a notification for each new invoice"
}
Each additional property must conform to the following schema
Type: stringMust be at least 1 characters long
This object is used to describe the type of the subscription
- SUBSCRIPTION is a single subscription
- SUBSCRIPTION_GROUP is a group of subscriptions
The status of the subscription
"ACTIVE"
The list allows to define the “notification” options for the subscription.
Only one option can be selected for the subscription.
Must contain a minimum of 1 items
The code of the option
Must be at least 1 characters long
"SINGLE_INVOICE"
This field should contain the label of the option (i18n field)
{
"fr-FR": "Option de notification",
"en-GB": "Notification option"
}
Each additional property must conform to the following schema
Type: stringMust be at least 1 characters long
A short description of the option
{
"fr-FR": "Recevoir chaque facture independement",
"en-GB": "Receive each invoice independently"
}
Each additional property must conform to the following schema
Type: stringMust be at least 1 characters long
[
{
"code": "SINGLE_INVOICE",
"label": {
"fr-FR": "Recevoir chaque facture independement",
"en-GB": "Receive each invoice independently"
},
"description": {
"fr-FR": "Recevoir chaque facture independement",
"en-GB": "Receive each invoice independently"
}
},
{
"code": "WEEKLY_INVOICE",
"label": {
"fr-FR": "Recevoir chaque facture independamment",
"en-GB": "Receive all invoices on a weekly basis"
},
"description": {
"fr-FR": "Recevoir chaque facture independamment",
"en-GB": "Receive all invoices on a weekly basis"
}
}
]
The list of the subscription codes that are part of the group
Must contain a minimum of 1 items
Allow the OpCo to decide the order of displaying the subscriptions or subscription groups (1 - means on top of the list, other numbers will follow).
It will only be compared against the same type of subscription (group or subscription).
If order is missing, the document will be placed at the bottom of the list.
1