destination-schemas.destination_schema.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client Show documentation
Library that provides client access to the FIT-Connect api-endpoints for sending, subscribing and routing
The newest version!
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://schema.fitko.de/fit-connect/xzufi/destination.schema.json",
  "type": "object",
  "title": "FIT-Connect Adressierungsinformationen",
  "description": "Payload der signierten Adressierungsinformationen",
  "examples": [
    {
      "submissionHost": "submission-api-testing.fit-connect.fitko.dev",
      "iss": "https://portal.auth-testing.fit-connect.fitko.dev",
      "services": [
        {
          "gebietIDs": [
            "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs:12345"
          ],
          "leistungIDs": [
            "urn:de:fim:leika:leistung:100"
          ]
        }
      ],
      "destinationId": "0c438057-ec3e-4ce0-b154-1683b5d3c2e8",
      "iat": 1637685592,
      "jti": "ae37e58b-e280-4706-b99e-738f24c8d98f"
    }
  ],
  "required": [
    "submissionHost",
    "iss",
    "services",
    "destinationId",
    "iat",
    "jti"
  ],
  "properties": {
    "submissionHost": {
      "type": "string",
      "title": "Submission-Host",
      "description": "Technischer Bezeichner für die Host-Adresse des für eine bestimmte Destination-ID zuständigen Zustelldienstes.",
      "examples": [
        "submission-api-testing.fit-connect.fitko.dev"
      ]
    },
    "iss": {
      "type": "string",
      "title": "Issuer des JWT",
      "description": "URL des Self-Service-Portals",
      "examples": [
        "https://portal.auth-testing.fit-connect.fitko.dev"
      ]
    },
    "services": {
      "type": "array",
      "title": "Verwaltungsleistungen",
      "description": "Die Liste der vom Zustellpunkt angebotenen Verwaltungsleistungen und geographischen Zuordnungen (siehe gebietIDs und leistungIDs)",
      "examples": [
        [
          {
            "gebietIDs": [
              "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs:12345"
            ],
            "leistungIDs": [
              "urn:de:fim:leika:leistung:100"
            ]
          }
        ]
      ],
      "items": {
        "type": "object",
        "title": "Verwaltungsleistung",
        "description": "Eine vom Zustellpunkt angebotene Verwaltungsleistung und geographischen Zuordnungen (siehe gebietIDs und leistungIDs)",
        "examples": [
          {
            "gebietIDs": [
              "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs:12345"
            ],
            "leistungIDs": [
              "urn:de:fim:leika:leistung:100"
            ]
          }
        ],
        "required": [
          "gebietIDs",
          "leistungIDs"
        ],
        "properties": {
          "gebietIDs": {
            "type": "array",
            "title": "gebietIDs",
            "description": "Eine Liste der zur Zuständigkeitsabbildung gehörigen Gebiets-IDs",
            "examples": [
              [
                "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs:12345"
              ]
            ],
            "items": {
              "type": "string",
              "title": "gebietID",
              "description": "Gebiets-ID als URN",
              "examples": [
                "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs:12345"
              ]
            }
          },
          "leistungIDs": {
            "type": "array",
            "title": "leistungIDs",
            "description": "Eine Liste der zur Zuständigkeitsabbildung gehörigen Leistungs-IDs",
            "examples": [
              [
                "urn:de:fim:leika:leistung:100"
              ]
            ],
            "items": {
              "type": "string",
              "title": "leistungID",
              "description": "Leistungs-ID als URN",
              "examples": [
                "urn:de:fim:leika:leistung:100"
              ]
            }
          }
        }
      }
    },
    "destinationId": {
      "type": "string",
      "title": "Destination-ID",
      "description": "Die für den Zustellpunkt vergebene ID",
      "examples": [
        "0c438057-ec3e-4ce0-b154-1683b5d3c2e8"
      ]
    },
    "iat": {
      "type": "integer",
      "title": "Zeitpunkt der Signaturerstellung (issued at)",
      "description": "Zeitpunkt der Signaturerstellung als Unix Timestamp",
      "examples": [
        1637685592
      ]
    },
    "jti": {
      "type": "string",
      "title": "JWT Token ID",
      "description": "Eindeutige ID des JWT",
      "examples": [
        "ae37e58b-e280-4706-b99e-738f24c8d98f"
      ]
    }
  }
}