Skip to content

Campaign Parameters

Description

Parameters which define a Campaign within a Brand in the system.

Campaign Parameterscontent typeapplication/jsontype [0]5ef32d5d-f240-462c-a7a4-ba4af221fa23idUUIDv7verUUIDv7brand_idBrand ParametersBrand Parameters

Validation

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Business Logic

Front End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Back End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

COSE Header Parameters

Metadata

type

Parameter Value
Required yes
Format Document Type
Type 5ef32d5d-f240-462c-a7a4-ba4af221fa23

The document TYPE.

Validation

MUST be a known document type.

id

Parameter Value
Required yes
Format UUIDv7

Document ID, created the first time the document is created. This must be a properly created UUIDv7 which contains the timestamp of when the document was created.

Validation

IF ver does not == id then a document with id and ver being equal MUST exist.

ver

Parameter Value
Required yes
Format UUIDv7

The unique version of the document. The first version of the document must set ver == id

Validation

The document version must always be >= the document ID.

brand_id

Parameter Value
Required yes
Format Document Reference
Valid References Brand Parameters
Exclusive campaign_id
category_id

A reference to the Brand Parameters Document this document lies under.

Validation

In addition to the validation performed for Document Reference type fields:

  • Any linked referenced document that includes a brand_id must match the brand_id of the referencing document.
  • MUST NOT be present in any document that contains campaign_id and category_id metadata.

Payload

TODO

Signers

The following user roles may sign documents of this type:

  • Registered

New versions of this document may be published by:

  • author
Copyright © 2024-2025 IOG Singapore, All Rights Reserved
License This document is licensed under CC-BY-4.0
Created 2024-12-27
Modified 2025-04-09
Authors Alex Pozhylenkov alex.pozhylenkov@iohk.io
Steven Johnson steven.johnson@iohk.io

Changelog

0.01 (2025-04-04)

  • First Published Version