Skip to main content

Header

Overview​

Header is a typed dictionary that provides general header information for messages exchanged with the KeySquare platform. It contains essential metadata for identifying the schema, template, and version of the message.

Definition​

from typing import TypedDict

class Header(TypedDict):
    """
    General header information for messages.

    Attributes:
        schemaId: Identifier for the schema
        templateId: Identifier for the template
        version: Version number
    """
    schemaId: int
    templateId: int
    version: int

Attributes​

  • schemaId: Identifier for the schema (int)
  • templateId: Identifier for the template (int)
  • version: Version number (int)

Usage Example​

from keysquarepy import Header

header: Header = {
    "schemaId": 1,
    "templateId": 101,
    "version": 2
}
print(header)

See Also​