ServiceDescriptionHierarchySearchResult

serviceDescriptions object

Treffer der Leistungs-Suche inklusive Seiteninformationen.

content object[]

Array [

idstringrequired

id, xzufi:Identifikator

namestringrequired

Inhalt aus dem leikaTextModul mit Code 03, wenn vorhanden, sonst 02. Zuvor werden Spezialisierungen anhand der ARS-Hierarchie in die Module eingearbeitet. Bei mehreren Modulen zu einem Code wird zusätzlich der Zugangskanal priorisiert: 100 (Online) vor 000 (Online/Offline) vor 200 (Offline).

teaserstring

Kurzer Vorschautext (Snippet) auf die Leistung aus dem leikaTextModul mit Code 24 (Teaser). Zuvor werden Spezialisierungen anhand der ARS-Hierarchie in die Module eingearbeitet. Bei mehreren Modulen greift anschließend die Zugangskanal-Priorisierung: 100 (Online) vor 000 (Online/Offline) vor 200 (Offline).

arsFederalstatestring[]

Der 2-stellige ARS des Bundeslandes. Ermöglicht die Unterscheidung zwischen Bundes- und Landesleistungen.

languageComplete object

Vollständigkeit der Felder zu einer Sprache

property name*boolean

onlineServiceLinks object[]

Zugehörige Links von Onlinediensten

Array [

idstring

id, xzufi:Identifikator

uristringrequired

uri, xs:anyURI

titlestring

titel, xs:string

descriptionstring

beschreibung, xs:string

statusOnlineServiceStatus

Status des Onlinedienstes

Possible values: [UNDEFINED, PLANNING, INITIALIZATION, TEST, PRODUCTION, MAINTENANCE, DEACTIVATION]

executionLanguagesstring[]

executionNationalities object[]

durchfuehrungStaatsangehoerigkeit, xzufi:Code.StaatsangehoerigkeitDestatis

Array [

destatisCodestring

iso2Codestring

]

isPublicDisplayAllowedbooleanrequired

kennzeichenOeffentlichAnzeigen, xs:boolean

]

availableLanguagesstring[]

Verfügbare Sprachen der Leistung

]

page object

sizeinteger<int64>

numberinteger<int64>

totalElementsinteger<int64>

totalPagesinteger<int64>

leikaMatch object

Gibt an, wie die Treffer zu den angefragten LeiKa-Schlüsseln ermittelt wurden.

matchTypestringrequired

Beziehung der Treffer zu den angefragten LeiKa-Schlüsseln.

Possible values: [EXACT, DESCENDANT, ANCESTOR, NONE]

effectiveLeikaIdsstring[]required

Die vollständigen, 14-stelligen LeiKa-Schlüssel, mit denen die letztlich erfolgreiche Suche ausgeführt wurde. Bei matchType ANCESTOR weichen sie von den angefragten Schlüsseln ab und geben an, auf welche Ebene der Hierarchie ausgewichen wurde; bei NONE ist die Menge leer. Es handelt sich um die Schlüssel der Suchanfrage, nicht um die der gefundenen Leistungen: Da die zweistellige Instanz bei bundeseinheitlichen Schlüsseln ignoriert wird, kann eine gefundene Leistung einen abweichenden Instanz-Präfix tragen.

Example: ["99008001000000"]

ServiceDescriptionHierarchySearchResult

{
  "serviceDescriptions": {
    "content": [
      {
        "id": "string",
        "name": "string",
        "teaser": "string",
        "arsFederalstate": [
          "string"
        ],
        "languageComplete": {},
        "onlineServiceLinks": [
          {
            "id": "string",
            "uri": "string",
            "title": "string",
            "description": "string",
            "status": "UNDEFINED",
            "executionLanguages": [
              "string"
            ],
            "executionNationalities": [
              {
                "destatisCode": "string",
                "iso2Code": "string"
              }
            ],
            "isPublicDisplayAllowed": true
          }
        ],
        "availableLanguages": [
          "string"
        ]
      }
    ],
    "page": {
      "size": 0,
      "number": 0,
      "totalElements": 0,
      "totalPages": 0
    }
  },
  "leikaMatch": {
    "matchType": "EXACT",
    "effectiveLeikaIds": [
      "99008001000000"
    ]
  }
}