Anfrage-parameter

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellen-version

Version der Schnittstelle.

Konstant „1.0“ oder „2.0“.

Muss

Einfach

STRING 10

soapenv:Body / GetAllgemeineAuskunft / Schnittstellenversion

Softwarename

In SHK Connect hinterlegter Name der Software.

Muss

Einfach

STRING 50

soapenv:Body / GetAllgemeineAuskunft / Softwarename

Software Passwort

In SHK Connect hinterlegtes Passwort.

Muss

Einfach

STRING 50

soapenv:Body / GetAllgemeineAuskunft / Softwarepasswort

Prozess

Gibt an, für welche Prozesse Informationen angefragt werden.
(Die Liste der am Server hinterlegten Prozesse und deren Versionen kann über die Prozessliste angefragt werden)

Kann

Einfach

Codeliste Prozesse

soapenv:Body / GetAllgemeineAuskunft / Prozess

Version

Gibt an, für welche Prozessversion Informationen angefragt werden.

(Die Liste der am Server hinterlegten Prozesse und deren Versionen kann über die Prozessliste angefragt werden)

Kann

Einfach

String

soapenv:Body / GetAllgemeineAuskunft / Version

Branche ID

Gibt an, für welche Branche Informationen angefragt werden.

(Die Liste der am Server hinterlegten Branchen kann über die Branchenliste angefragt werden)

Kann

Einfach

Integer

soapenv:Body / GetAllgemeineAuskunft / BrancheID

Umkreis

Unterstruktur zur Übertragung der Daten für die Umkreissuche.

Kann

Einfach

-

soapenv:Body / GetAllgemeineAuskunft / Umkreis

Postleitzahl

Gibt an, für welche Postleitzahl Informationen angefragt werden.

Muss

Einfach

Codeliste Prozesse

soapenv:Body / GetAllgemeineAuskunft / Umkreis / Postleitzahl

Entfernung

Gibt an, für welche Entfernung zum angegebenen Ort Informationen angefragt werden.

Muss

Einfach

Codeliste Prozesse

soapenv:Body / GetAllgemeineAuskunft / Umkreis / Entfernung

Dateninhalt

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle.

Konstant „1.0“ oder „2.0“.

Muss

Einfach

STRING 10

env:Body / GetAllgemeineAuskunftAntwort / Schnittstellenversion

Serverkennung

Identifikation des Servers.

Muss

Einfach

STRING 40

env:Body / GetAllgemeineAuskunftAntwort / Serverkennung

Status

Unterstruktur zur Übertragung des Status der Antwort.

Muss

Einfach

-

env:Body / GetAllgemeineAuskunftAntwort / Status

Code

Codierter Status der Antwort.

Muss

Einfach

Codeliste Status

env:Body / GetAllgemeineAuskunftAntwort / Status / Code

Meldung

Statusmeldung im Klartext.

Kann

Einfach

STRING 256

env:Body / GetAllgemeineAuskunftAntwort / Status / Meldung

Unternehmen

Unterstruktur zur Übertragung eines Unternehmens.

Muss

Mehrfach

-

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen

Unternehmens ID

ID des Unternehmens innerhalb des Servers.

Muss

Einfach

INTEGER

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / ID

Name

Name des Unternehmens

Muss

Einfach

STRING 256

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Name

Strasse

Straße des Unternehmens

Kann

Einfach

STRING 256

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Strasse

PLZ

PLZ des Unternehmens

Kann

Einfach

STRING 15

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / PLZ

Ort

Ort des Unternehmens

Kann

Einfach

STRING 256

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Ort

Land

Land des Unternehmens

Kann

Einfach

STRING 256

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Land

Kundennummer erforderlich

Angabe, ob bei einem Login die Kundennummer erforderlich ist.

Kann

Einfach

Boolean

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Kundennummer_erforderlich

Benutzername erforderlich

Angabe, ob bei einem Login der Benutzername erforderlich ist

Kann

Einfach

Boolean

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Benutzername_erforderlich

Password erforderlich

Angabe, ob bei einem Login das Passwort erforderlich ist

Kann

Einfach

Boolean

env:Body / GetAllgemeineAuskunftAntwort / Unternehmen / Password_erforderlich

Anfrage-parameter

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle

Konstant „1.0“ oder „2.0“

Muss

Einfach

STRING 10

soapenv:Body / GetIndividuelleAuskunft / Schnittstellenversion

Softwarename

In SHK Connect hinterlegter Name der Software.

Muss

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Softwarename

Software Passwort

In SHK Connect hinterlegtes Passwort.

Muss

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Softwarepasswort

Unternehmens ID

ID des Unternehmens zu dem Informationen angefragt werden.

Muss

Einfach

STRING 256

soapenv:Body / GetIndividuelleAuskunft / Unternehmens ID

Kundennummer

Kundennummer des Anwenders beim angefragten Unternehmen.

Kann

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Kundennummer

Benutzername

Benutzername des Anwenders beim angefragten Unternehmen.

Kann

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Benutzername

Passwort

Passwort des Anwenders beim angefragten Unternehmen.

Kann

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Passwort

Prozesscode

Angabe des Prozesscodes, für den Informationen bereitgestellt werden sollen.
(Die Liste der am Server hinterlegten Prozesse und deren Versionen kann über die Prozessliste angefragt werden)

Kann

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Prozesscode

Version

Angabe der Version des Prozesses, für den Informationen bereitgestellt werden sollen.
(Die Liste der am Server hinterlegten Prozesse und deren Versionen kann über die Prozessliste angefragt werden)

Kann

Einfach

STRING 50

soapenv:Body / GetIndividuelleAuskunft / Version

Dateninhalt

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle

Konstant „1.0“ oder „2.0“

Muss

Einfach

STRING 10

env:Body / GetIndividuelleAuskunftAntwort / Schnittstellenversion

Serverkennung

Identifikation des Servers

Muss

Einfach

STRING 40

env:Body / GetIndividuelleAuskunftAntwort / Serverkennung

Status

Unterstruktur zur Übertragung des Status der Antwort.

Muss

Einfach

-

env:Body / GetIndividuelleAuskunftAntwort / Status

Code

Codierter Status der Antwort.

Muss

Einfach

Codeliste Status

env:Body / GetIndividuelleAuskunftAntwort / Status / Code

Meldung

Statusmeldung im Klartext.

Kann

Einfach

STRING 256

env:Body / GetIndividuelleAuskunftAntwort / Status / Meldung

Prozessliste

Unterstruktur zur Abbildung der Informationen zu den Prozessen.

Muss

Einfach

-

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste

Prozess

Struktur zur Übertragung der Informationen zu einem Prozess.

Muss

Mehrfach

-

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess

Prozesscode

Codierte Angabe des Prozesses.

Muss

Einfach

Codeliste Prozesse

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Prozesscode

Version

Version des Prozesses.

Kann

Einfach

STRING 50

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Version

Teilprozesse

Unterstruktur zur Abbildung der Teilprozesse.

Kann

Einfach

-

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Teilprozesse

Teilprozess

Codierte Angabe des Teilprozesses.

Kann

Mehrfach

Codeliste Teilprozesse

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Teilprozesse / Teilprozess

URL

URL unter der die bilaterale Kommunikation erfolgt.

Für einen Prozess kann nur die Angabe URL oder Link genutzt werden. Eine der Angaben muss übertragen werden.

Kann

Einfach

STRING 256

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / URL

Link

Unterstruktur zur Übertragung der Informationen zu einem Link.

Für einen Prozess kann nur die Angabe URL oder Link genutzt werden. Eine der Angaben muss übertragen werden.

Kann

Mehrfach

-

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link

Beschreibung

Beschreibung des Links.

Muss

Einfach

STRING 80

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Beschreibung

URL

URL zum Download der Datei.

Muss

Einfach

STRING 256

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / URL

Datum

Datum der Datei.

Kann

Einfach

TT-MM-JJJJ

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Datum

Größe

Größe der Datei in Byte.

Kann

Einfach

INTEGER

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Groesse

Authentifizierungs-methode

Art der Authentifizierung bei Nutzung der URL.

Muss

Einfach

Codeliste

Authenti-fizierungs-methoden

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Authentifizierungsmethode

Datum der Daten

Datum der hinterlegten Daten im

Format „TT.MM.JJJJ“.

Muss

Einfach

STRING 10

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / DatenDatum

Änderungsinfor-mationen

Informationen, was sich an den Daten geändert hat.

Kann

Einfach

STRING 1000

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / AenderungsInfo

Cookieliste

Unterstruktur zur Übertragung der Cookies zu einem Link.

Kann nur genutzt werden wenn die Authentifizierungsmethode „COOKIE“ genutzt wird.

Kann

Einfach

-

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Cookieliste

Cookie

Cookie, welches zur Authentifizierung genutzt wird.

Muss

Mehrfach

STRING 64.000

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Cookieliste / Cookie

Dateityp

Angabe um was für eine Datei es sich handelt (PDF, DNM, usw.).

Kann

Einfach

STRING 50

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Dateityp

Dateiname Original

Angabe wie der original Dateiname ist, auf den der Link verweist.

Kann

Einfach

STRING 50

env:Body / GetIndividuelleAuskunftAntwort / Prozessliste / Prozess / Link / Dateiname_org

Anfrageparameter

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle

Konstant „1.0“ oder „2.0“

Muss

Einfach

STRING 10

soapenv:Body / GetBranchenListe / Schnittstellenversion

Softwarename

In SHK Connect hinterlegter Name der Software

Muss

Einfach

STRING 50

soapenv:Body / GetBranchenListe / Softwarename

Software Passwort

In SHK Connect hinterlegtes Passwort

Muss

Einfach

STRING 50

soapenv:Body / GetBranchenListe / Softwarepasswort

Dateninhalt

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle.

Konstant „1.0“

Muss

Einfach

STRING 10

env:Body / GetBranchenListeAntwort / Schnittstellenversion

Serverkennung

Identifikation des Servers.

Muss

Einfach

STRING 40

env:Body / GetBranchenListeAntwort / Serverkennung

Status

Unterstruktur zur Übertragung des Status der Antwort.

Muss

Einfach

-

env:Body / GetBranchenListeAntwort / Status

Code

Codierter Status der Antwort.

Muss

Einfach

Codeliste Status

env:Body / GetBranchenListeAntwort / Status / Code

Meldung

Statusmeldung im Klartext.

Kann

Einfach

STRING 256

env:Body / GetBranchenListeAntwort / Status / Meldung

Branche

Unterstruktur zur Übertragung einer Branche.

Muss

Mehrfach

-

env:Body / GetBranchenListeAntwort / Branche

Branchen Id

Identifikation der Branche.

Muss

Einfach

INTEGER

env:Body / GetBranchenListeAntwort / Branche / ID

Branchenname

Name der Branche.

Muss

Einfach

STRING 256

env:Body / GetBranchenListeAntwort / Branche / Name

Anfrageparameter

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle.

Konstant „1.0“ oder „2.0“

Muss

Einfach

STRING 10

soapenv:Body / GetProzessListe / Schnittstellenversion

Softwarename

In SHK Connect hinterlegter Name der Software.

Muss

Einfach

STRING 50

soapenv:Body / GetProzessListe / Softwarename

Software Passwort

In SHK Connect hinterlegtes Passwort.

Muss

Einfach

STRING 50

soapenv:Body / GetProzessListe / Softwarepasswort

Dateninhalt

Beschreibung

Muss /Kann

Einfach / Mehrfach

Format

Referenz XML

Schnittstellenversion

Version der Schnittstelle.

Konstant „1.0“.

Muss

Einfach

STRING 10

env:Body / GetProzessListeAntwort / Schnittstellenversion

Serverkennung

Identifikation des Servers.

Muss

Einfach

STRING 40

env:Body / GetProzessListeAntwort / Serverkennung

Status

Unterstruktur zur Übertragung des Status der Antwort.

Muss

Einfach

-

env:Body / GetProzessListeAntwort / Status

Code

Codierter Status der Antwort.

Muss

Einfach

Codeliste Status

env:Body / GetProzessListeAntwort / Status / Code

Meldung

Statusmeldung im Klartext.

Kann

Einfach

STRING 256

env:Body / GetProzessListeAntwort / Status / Meldung

Prozess

Unterstruktur zur Übertragung eines Prozesses.

Muss

Mehrfach

-

env:Body / GetProzessListeAntwort / Prozess

Prozesscode

Identifizierender Code für den Prozess.

Muss

Einfach

STRING 50

env:Body / GetProzessListeAntwort / Prozess / Prozesscode

Version

Version des Prozesses.

Muss

Einfach

INTEGER

env:Body / GetProzessListeAntwort / Prozess / Version

Name

Name der Branche.

Muss

Einfach

STRING 256

env:Body / GetProzessListeAntwort / Prozess / Name

Teilprozess

Unterstruktur zur Übertragung eines Teilprozesses.

Kann

Mehrfach

-

env:Body / GetProzessListeAntwort / Prozess / Teilprozess

Teilprozesscode

Identifizierender Code für den Teilprozess.

Muss

Einfach

STRING 50

env:Body / GetProzessListeAntwort / Prozess / Teilprozess / Teilprozesscode

Version

Version des Teilprozesses.

(entspricht der Version des Prozesses, zu dem er gehört)

Muss

Einfach

STRING 50

env:Body / GetProzessListeAntwort / Prozess / Teilprozess / Version

Name

Name des Teilprozesses.

Muss

Einfach

STRING 50

env:Body / GetProzessListeAntwort / Prozess / Teilprozess / Name

Code

Bedeutung

STD

Stammdaten DATANORM

Code

Bedeutung

0

Es ist kein Fehler aufgetreten

1

Fehler bei der Authentifizierung der anfragenden Software

2

Der angefragte Prozess existiert nicht im SHK Connect Server

3

Das angefragte Unternehmen existiert nicht im SHK Connect Server

4

Fehler bei der Authentifizierung des Anwenders beim Unternehmen

5

Angefragte Branche existiert nicht

6

Angefragte PLZ aus der Umkreissuche existiert nicht

7

Fehler bei der Kommunikation mit dem angefragten Unternehmen

9

Fehlerhafte Anfrage (z.B. Pflichtfelder in der Anfrage fehlen)

10

Testantwort

Code

Bedeutung

URL

Die Authentifizierung erfolgt über die URL

HTTPAUTH

Die Authentifizierung erfolgt über Http Auth

KEINE

Es ist keine Authentifizierung erforderlich

COOKIE

Die Authentifizierung erfolgt über Cookies

Code

Bedeutung

Erläuterung

400

Bad Request

Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized

Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im „WWW-Authenticate“-Header-Feld der Antwort übermittelt.

402

Payment Required

(reserviert)

403

Forbidden

Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt. Diese Entscheidung wurde – anders als im Fall des Statuscodes 401 – unabhängig von Authentifizierungsinformationen getroffen, auch etwa wenn eine als HTTPS konfigurierte URL nur mit HTTP aufgerufen wurde.

404

Not Found

Die angeforderte Ressource wurde nicht gefunden. Dieser Statuscode kann ebenfalls verwendet werden, um eine Anfrage ohne näheren Grund abzuweisen. Links, welche auf solche Fehlerseiten verweisen, werden auch als „Tote Links“ bezeichnet.

405

Method Not Allowed

Die Anfrage darf nur mit anderen HTTP-Methoden (z. B. GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im „Allow“-Header-Feld der Antwort übermittelt.

406

Not Acceptable

Die angeforderte Ressource steht nicht in der gewünschten Form zur Verfügung. Gültige „Content-Type“-Werte können in der Antwort übermittelt werden.

407

Proxy Authentication Required

Analog zum Statuscode 401 ist hier zunächst eine Authentifizierung des Clients gegenüber dem verwendeten Proxy erforderlich. Wie die Authentifizierung durchgeführt werden soll, wird im „Proxy-Authenticate“-Header-Feld der Antwort übermittelt.

408

Request Time-out

Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.

409

Conflict

Die Anfrage wurde unter falschen Annahmen gestellt. Im Falle einer PUT-Anfrage kann dies zum Beispiel auf eine zwischenzeitliche Veränderung der Ressource durch Dritte zurückgehen.

410

Gone

Die angeforderte Ressource wird nicht länger bereitgestellt und wurde dauerhaft entfernt.

411

Length Required

Die Anfrage kann ohne ein „Content-Length“-Header-Feld nicht bearbeitet werden.

412

Precondition Failed

Eine in der Anfrage übertragene Voraussetzung, zum Beispiel in Form eines „If-Match“-Header-Felds, traf nicht zu.

413

Request Entity Too Large

Die gestellte Anfrage war zu groß, um vom Server bearbeitet werden zu können. Ein „Retry-After“-Header-Feld in der Antwort kann den Client darauf hinweisen, dass die Anfrage eventuell zu einem späteren Zeitpunkt bearbeitet werden könnte.

414

Request-URI Too Long

Die URL der Anfrage war zu lang. Ursache ist oft eine Endlosschleife aus Redirects.

415

Unsupported Media Type

Der Inhalt der Anfrage wurde mit ungültigem oder nicht erlaubtem Medientyp übermittelt.

416

Requested range not satisfiable

Der angeforderte Teil einer Ressource war ungültig oder steht auf dem Server nicht zur Verfügung.

417

Expectation Failed

Verwendet im Zusammenhang mit einem „Expect“-Header-Feld. Das im „Expect“-Header-Feld geforderte Verhalten des Servers kann nicht erfüllt werden.

421

There are too many connections from your internet address

Wird verwendet, wenn die Verbindungshöchstzahl überschritten wird

422

Unprocessable Entity

Wird verwendet, wenn weder die Rückgabe von Statuscode 415 noch 400 gerechtfertigt wäre, eine Verarbeitung der Anfrage jedoch zum Beispiel wegen semantischer Fehler abgelehnt wird (RFC 4918).

423

Locked

Die angeforderte Ressource ist zurzeit gesperrt (RFC 4918).

424

Failed Dependency

Die Anfrage konnte nicht durchgeführt werden, weil sie das Gelingen einer vorherigen Anfrage voraussetzt (RFC 4918).

425

Unordered Collection

In den Entwürfen von WebDav Advanced Collections definiert, aber nicht im "Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol" (RFC 3648).

426

Upgrade Required

Der Client sollte auf Transport Layer Security (TLS/1.0) umschalten (RFC 2817).

500

Internal Server Error

Dies ist ein „Sammel-Statuscode“ für unerwartete Serverfehler.

501

Not Implemented

Die Funktionalität, um die Anfrage zu bearbeiten, wird von diesem Server nicht bereitgestellt. Ursache ist zum Beispiel eine unbekannte oder nicht unterstützte HTTP-Methode.

502

Bad Gateway

Der Server konnte seine Funktion als Gateway oder Proxy nicht erfüllen, weil er seinerseits eine ungültige Antwort erhalten hat.

503

Service Unavailable

Der Server steht, zum Beispiel wegen Überlast oder Wartungsarbeiten, zurzeit nicht zur Verfügung. Ein „Retry-After“-Header-Feld in der Antwort kann den Client auf einen Zeitpunkt hinweisen, zu dem die Anfrage eventuell bearbeitet werden könnte.

504

Gateway Time-out

Der Server konnte seine Funktion als Gateway oder Proxy nicht erfüllen, weil er innerhalb einer festgelegten Zeitspanne keine Antwort von seinerseits benutzten Servern oder Diensten erhalten hat.

505

HTTP Version not supported

Die benutzte HTTP-Version (gemeint ist die Zahl vor dem Komma) wird vom Server nicht unterstützt oder abgelehnt.

506

Variant Also Negotiates

(RFC 2295)

507

Insufficient Storage

Die Anfrage konnte nicht bearbeitet werden, weil der Speicherplatz des Servers dazu zur Zeit nicht mehr ausreicht (RFC 4918).

509

Bandwidth Limit Exceeded

Die Anfrage wurde verworfen, weil sonst die verfügbare Bandbreite überschritten werden würde (inoffizielle Erweiterung einiger Server).

510

Not Extended

Die Anfrage enthält nicht alle Informationen, die die angefragte Server-Extension zwingend erwartet (RFC 2774).