Skip to content

Campaign Parameters Form Template

Description

A Campaign Parameters Form Template defines both:

  • The data that is entered in the Form.
  • Formatting hints for the collection of the data in a form.

A Campaign Parameters Form Template is a JSON Schema Document.

Campaign Parameters entry SHOULD use the hints when collecting data defined by the Campaign Parameters Form Template to provide a consistent user interface. It CAN also use those hints when re-displaying the full forms data.

Alternatively a Campaign Parameters Presentation Template can be used to format the Campaign Parameters data for presentation.

The Campaign Parameters Document is intentionally general, however it may be linked to a brand/campaign or category via the template used by the Campaign Parameters.

The payload of a Campaign Parameters is controlled by its template.

Campaign Parameters Form TemplateCampaign Parameters Form    Template Document    Relationshipscluster_system_parametersSystem ParametersCampaign Parameters Form Template                         Campaign Parameters Form Template                    content typeapplication/schema+jsontype0ce8ab38-9258-4fbc-a62e-7faa6e58318f60185874-7e13-407c-a06c-238ffe637ae65ef32d5d-f240-462c-a7a4-ba4af221fa23idDocument IdverDocument VerCampaign Parameters                             Campaign Parameters                        Campaign Parameters:e->Campaign Parameters Form Template:w1*

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 0ce8ab38-9258-4fbc-a62e-7faa6e58318f,
60185874-7e13-407c-a06c-238ffe637ae6,
5ef32d5d-f240-462c-a7a4-ba4af221fa23

The document TYPE.

type Validation

MUST be a known document type.

id

Parameter Value
Required yes
Format Document Id

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.

id Validation

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

ver

Parameter Value
Required yes
Format Document Ver

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

ver represents new versions of the same document as it changes over time.

ver Validation

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

Payload

JSON Schema document which defines the valid contents and formatting hints for the collection of data for a Campaign Parameters Document.

Signers

The following Admin roles may sign documents of this type:

  • Brand Admin

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-05-30
Authors Alex Pozhylenkov alex.pozhylenkov@iohk.io
Steven Johnson steven.johnson@iohk.io

Changelog

0.01 (2025-04-04)

  • First Published Version

0.03 (2025-05-05)

  • Use generalized parameters.

0.04 (2025-05-05)

  • Generalize the Form Template definitions.