{
  "$id": "https://tcpp.digital/schema/1.3.0/emaid_get_request.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "tcpp emaid_get_request schema",
  "x-tcpp-version": "1.3.0",
  "description": "tcpp emaid_get_request schema",
  "type": "object",
  "properties": {
    "tcpp": {
      "description": "url to tcpp version infos",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 120,
      "pattern": "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,63}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$"
    },
    "head": {
      "$ref": "#/$defs/definition_head"
    },
    "record": {
      "description": "'record_type':'emaid_get', 'record_direction':'request'",
      "type": "object",
      "properties": {
        "inquiry_type": {
          "description": "RFID|VEHICLE|CARD|APP|DISPLAY|...",
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "inquiry_details": {
          "description": "method|id|expire_date|mac|vin|...",
          "type": [
            "object",
            "null"
          ]
        },
        "device": {
          "description": "device: identify, hardware equipment, software",
          "type": "object",
          "properties": {
            "identification": {
              "description": "needed, if not the same than own id! module_name|module_id|...",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "module_id": {
                  "description": "id of module if not same",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "module_name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "name of module",
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "module_type": {
                  "description": "tcpp type like LIU|CSU|...",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 3,
                  "maxLength": 3,
                  "pattern": "^[A-Z]*$"
                },
                "module_manufacturer_id": {
                  "description": "id of manufacturer",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "subject_id": {
                  "description": "id to legal subject if new to create",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "reference_id": {
                  "description": "id to reference",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                }
              }
            },
            "equipment": {
              "description": "equipment_id|equipment_cid...",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "equipment_name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Name of Equipment",
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "equipment_sign": {
                  "description": "MODULE{.DISPLAY}|CABLE{.CHARGING}|IO{.READER}|...",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 3,
                  "maxLength": 50,
                  "pattern": "^[0-9A-Z._\\-]*$"
                },
                "equipment_id": {
                  "description": "id of equipment",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "equipment_sn": {
                  "description": "serial number",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "equipment_cid": {
                  "description": "cid of equipment",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "equipment_manufacturer_id": {
                  "description": "manufacturer id",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "equipment_manufacturer_name": {
                  "description": "Name of manufacturer",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                }
              }
            },
            "software": {
              "description": "software informations...",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "software_sign": {
                  "description": "OPERATING.CONTROLUNIT|...",
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 50,
                  "pattern": "^[0-9A-Z._\\-]*$"
                },
                "issuer_sign": {
                  "description": "AUTHORITY|MANUFACTURER|COMPANY|ORGANISATION",
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 50,
                  "pattern": "^[0-9A-Z._\\-]*$"
                },
                "issuer_name": {
                  "description": "name of issuer",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "issuer_id": {
                  "description": "id of issuer",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "created_date": {
                  "description": "date of documentation created",
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "effective_date": {
                  "description": "date of start effective",
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "expire_date": {
                  "description": "date of expiring",
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "hash_type": {
                  "description": "hash of file type, f.e. SHA-256",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "hash_pattern": {
                  "description": "hash of file type, min-length and pattern",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120
                },
                "hash_value": {
                  "description": "hash of file value ",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                },
                "proofed_sign": {
                  "description": "PROOFED.VALID|PROOFED.NOTVALID|UNPROOFED.INTENT|UNPROOFED.ERROR|UNPROOFED.OPEN...",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 3,
                  "maxLength": 50,
                  "pattern": "^[0-9A-Z._\\-]*$"
                },
                "proofed_udt": {
                  "description": "universal datetime",
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "proofed_id": {
                  "description": "id of proofed",
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 0,
                  "maxLength": 120,
                  "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
                }
              }
            }
          },
          "required": [
            "identification",
            "equipment",
            "software"
          ]
        },
        "legal_subjects": {
          "description": "other subjects/backends/services linked",
          "type": [
            "array",
            "null"
          ]
        }
      },
      "required": [
        "inquiry_type",
        "inquiry_details",
        "device"
      ]
    },
    "participants": {
      "description": "participants of process or communication",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/definition_participant"
      }
    },
    "references": {
      "description": "references to request or process(es)",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "properties": {
          "reference_id": {
            "description": "id of internal reference / can be empty",
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 120,
            "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
          },
          "head": {
            "description": "referencing head 1:1",
            "$ref": "#/$defs/definition_head"
          },
          "jws": {
            "description": "jws signature",
            "type": [
              "object",
              "null"
            ]
          }
        },
        "required": [
          "reference_id",
          "head"
        ]
      }
    }
  },
  "required": [
    "tcpp",
    "head",
    "record",
    "references"
  ],
  "$defs": {
    "definition_head": {
      "description": "unified head informations",
      "type": "object",
      "properties": {
        "record_type": {
          "description": "tcpp record",
          "type": "string",
          "minLength": 3,
          "maxLength": 50,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "record_direction": {
          "description": "request|response|internal",
          "type": "string",
          "minLength": 3,
          "maxLength": 8,
          "pattern": "^[a-z]*$"
        },
        "record_udt": {
          "description": "universal datetime",
          "type": "string",
          "format": "date-time"
        },
        "record_pagination": {
          "description": "unique creating number",
          "type": "number",
          "minimum": 1,
          "multipleOf": 1
        },
        "record_version": {
          "description": "version",
          "type": "string",
          "minLength": 5,
          "maxLength": 10,
          "default": "1.3.0",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
        },
        "origin_type": {
          "description": "tcpp type of origin",
          "type": "string",
          "minLength": 3,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "origin_id": {
          "description": "tcpp id of origin",
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "target_type": {
          "description": "tcpp type of target",
          "type": "string",
          "minLength": 3,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "target_id": {
          "description": "tcpp id of target",
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "context_type": {
          "description": "tcpp type of context / can be empty",
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "context_id": {
          "description": "id of context / can be empty",
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "error_code": {
          "description": "tcpp error handling, Hex",
          "type": "string",
          "pattern": "^[0-9A-F]{6}$"
        },
        "error_text": {
          "description": "tcpp error text (optional)",
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        }
      },
      "required": [
        "record_type",
        "record_direction",
        "record_udt",
        "record_pagination",
        "record_version",
        "origin_type",
        "origin_id",
        "target_type",
        "target_id",
        "context_id",
        "context_type",
        "error_code"
      ]
    },
    "definition_participant": {
      "description": "unified participant informations",
      "type": "object",
      "properties": {
        "participant_type": {
          "description": "tcpp type",
          "type": "string",
          "minLength": 3,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "participant_id": {
          "description": "tcpp id",
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "participant_perms": {
          "description": "rights/functions of participation",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "description": "read|control|push|broker|...",
            "minLength": 3,
            "maxLength": 10,
            "pattern": "^[a-z]*$"
          }
        },
        "forwarder_type": {
          "description": "forwarder type",
          "type": [
            "string",
            "null"
          ],
          "minLength": 3,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "forwarder_id": {
          "description": "forwarder id",
          "type": [
            "string",
            "null"
          ],
          "minLength": 3,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        },
        "approver_type": {
          "description": "approved by type",
          "type": [
            "string",
            "null"
          ],
          "minLength": 3,
          "maxLength": 3,
          "pattern": "^[A-Z]*$"
        },
        "approver_id": {
          "description": "approved by id",
          "type": [
            "string",
            "null"
          ],
          "minLength": 3,
          "maxLength": 120,
          "pattern": "^[0-9A-Za-z.,;:%&$#*_/\\-+ !?(){}\\[\\]@~=]*$"
        }
      },
      "required": [
        "participant_type",
        "participant_id",
        "participant_perms",
        "approver_type",
        "approver_id"
      ]
    }
  }
}