This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Subscriber

Type: object

In Pilot A subscriber 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.

No Additional Properties

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.

root if
Type: object

root if eventHeader
Type: object

root if eventHeader source

Must not be:

root if eventHeader source not
Type: const
Specific value: "OPCO"
root then
Type: object

The following properties are required:

  • request

root eventHeader
Type: object

The event message header providing metadata details.

 No Additional Properties

root eventHeader allOf item 0
Type: object

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.

root eventHeader allOf item 0 if
Type: object

root eventHeader allOf item 0 if source
Type: const
Specific value: "OPCO"
root eventHeader allOf item 0 then
Type: object

root eventHeader allOf item 0 then type
Type: const
Specific value: "EVENT"
root eventHeader allOf item 1
Type: object

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.

root eventHeader allOf item 1 if
Type: object

root eventHeader allOf item 1 if source
Type: const
Specific value: "SPARK"
root eventHeader allOf item 1 then
Type: object

root eventHeader allOf item 1 then type
Type: const
Specific value: "COMMAND"

root eventHeader source
Type: enum (of string)

The source entity of this event

Must be one of:

  • "OPCO"
  • "SPARK"

Example:

"OPCO"

root eventHeader version
Type: string

The version of the json event format

Must be at least 1 characters long


Example:

"v1"

root eventHeader type
Type: enum (of string)

Type of event:

  • COMMAND to request a change on master
  • EVENT from master to publish a change

Must be one of:

  • "EVENT"
  • "COMMAND"

Example:

"EVENT"

root eventHeader documentType
Type: enum (of string)

The type of the document

Must be one of:

  • "SUBSCRIBER"

Example:

"SUBSCRIBER"

root request
Type: object
No Additional Properties

root request id
Type: string

Identifier of the request.

  • From SPARK to the OpCo is the technical id of the entity (_id)
  • From the OpCo to SPARK is the identifier provided by SPARK in response to the change request

Must be at least 1 characters long


Example:

"236124362632423"

root request target
Type: enum (of string)

The target, consumer of the request

Must be one of:

  • "OPCO"
  • "SPARK"

Example:

"OPCO"

root error
Type: object

This object is used if errors are raised by the master (OpCO) receiving a COMMAND. This entity should be included in the response EVENT, if the case.

 No Additional Properties
Example:

{
    "code": "SUBSCRIBER_NOT_FOUND",
    "message": "The subscriber was not found"
}

root error code
Type: enum (of string)

The error code

Must be one of:

  • "SUBSCRIBER_NOT_FOUND"
  • "TECHNICAL_FAILURE"
  • "BUSINESS_LOGIC_ERROR"

Example:

"SUBSCRIBER_NOT_FOUND"

root error message
Type: string

A message describing the error

Must be at least 1 characters long


Example:

"The subscriber was not found"

root document

The payload of the event to be ingested

Type: object

This object contains the actual data of the subscriber event

 No Additional Properties

root document anyOf item 0
Type: object

The following properties are required:

  • subscriptionListToAdd
root document anyOf item 1
Type: object

The following properties are required:

  • subscriptionListToDelete

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.

root document if
Type: object

root document if individual
Type: const
Specific value: true
root document then
Type: object

The following properties are required:

  • name
  • firstName
root document else
Type: object

The following properties are required:

  • name

root document emailAddress
Type: stringFormat: email

The email address of the subscriber

Must be at least 1 characters long


Example:

"test@gmail.com"

root document accountId
Type: string

The account identifier of the subscriber

Must be at least 1 characters long


Example:

"123456"

root document name
Type: string

Name of the subscriber:

  • used as last name in case of individual
  • department/service name otherwise

Must be at least 1 characters long


Example:

"Doe"

root document firstName
Type: string

First name of the subscriber

Must be at least 1 characters long


Example:

"John"

root document middleName
Type: string

Middle name of the subscriber

Must be at least 1 characters long


Example:

"Doe"

root document individual
Type: boolean Default: true

Flag to indicate if the subscriber is an individual or a service/department.
If true, the name field is used as last name.
If omitted, the subscriber is considered as an individual (true)
Example:

true

root document contactId
Type: string

ContactId if it is a known user

Must be at least 1 characters long


Example:

"123456"

root document status
Type: enum (of string)

The status of the subscriber.
- PENDING for creation and modification
- ACTIVE if the subscriber is active
- DELETED if the subscriber is to be deleted

Must be one of:

  • "PENDING"
  • "ACTIVE"
  • "DELETED"

Example:

"ACTIVE"

root document subscriptionListToAdd
Type: array of string

The list of subscription codes to add to the subscriber

 No Additional Items

Each item of this array must be:

root document subscriptionListToAdd subscriptionListToAdd items
Type: string

Must be at least 1 characters long


Examples:

[
    "INVOICE_NOTIFICATION"
]

[
    "INVOICE_NOTIFICATION",
    "PAYMENT_REMINDER",
    "ACCOUNT_UPDATE"
]

root document subscriptionListToDelete
Type: array of string

The list of subscription codes to remove from the subscriber

 No Additional Items

Each item of this array must be:

root document subscriptionListToDelete subscriptionListToDelete items
Type: string

Must be at least 1 characters long


Example:

[
    "INVOICE_NOTIFICATION"
]

root document lastModified
Type: stringFormat: date-time

The date of the last modification of the subscriber
Example:

"2025-02-23T08:30:22.804Z"