EDICENTER-Testkonverter-Webservice

Neben der Website (https://editest.webedifact.com/) lässt sich die Testkonvertierung automatisiert über einen Webservice nutzen.
Hinweis: dies ist kein SOAP-Webservice und es gibt keine Schnittstellenbeschreibung in maschinenlesbarem Format z. B. WSDL.

Der Webservice stellt 2 HTTP-Anfragen zur Verfügung: GetAlleEmpfaengerNachrichtProfile und Konvertiere.

GetAlleEmpfaengerNachrichtProfile

Eine Konvertierung bei EDICENTER muss eindeutig über 2 Informationen spezifiziert werden:

• Empfänger der konvertierten EDI-Datei und
• Nachrichtenart (Belegart) der EDI-Datei

GetAlleEmpfaengerNachrichtProfile liefert die Liste aller verfügbaren Empfänger-Nachrichtenart-Profile.
Jedes Profil hat eine eindeutige ID.
Die Anfrage Konvertiere (siehe unten) erwartet als Anfrage-Parameter EmpfaengerNachrichtID eine ID aus dieser Liste.

URL

https://editest.webedifact.com/Webservice/GetAlleEmpfaengerNachrichtProfile

HTTP-Methode: GET

PARAMETER

BEISPIEL-REQUEST

GET https://editest.webedifact.com/Webservice/GetAlleEmpfaengerNachrichtProfile?Kennwort=1234 HTTP/1.1
Host: editest.webedifact.com        
    

RESPONSE

Eine Liste der Empfänger-Nachricht-Profile im JSON-Format.

Beispiel (Ausschnitt):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "ID": "1",
    "Receiver": {
      "Name": "ALDI IRLAND",
      "Identification": "0041498000066",
      "EdicenterID": "ALDIIE"
    },
    "Message": "INVOIC",
    "Format": "UNIDOC",
    "Mapping": "UNIDOC_to_INVOIC-D01B_ALDIHO_EH"
  },
  {
    "ID": "2",
    "Receiver": {
      "Name": "BAHAG EDI-SUPPORT",
      "Identification": "9006713000000",
      "EdicenterID": "BAHAAT"
    },
    "Message": "INVOIC",
    "Format": "UNIDOC",
    "Mapping": "UNIDOC_to_INVOIC-D01B_BAHAGZ_EH"
  },

        ...

]
    

Konvertiere

URL

https://editest.webedifact.com/Webservice/Konvertiere

HTTP-Methode: POST

PARAMETER

• Folgende Parameter (Name-Wert-Paare) müssen in der URL der Anfrage übergeben werden:
  

  NAME	WERT	BEISPIEL
  Kennwort	Kennwort bekommen Sie von EDI Center auf Anfrage
  EMailAdresse	Gültige E-Mail-Adresse. Ist die Konvertierung erfolgreich, schickt das System innerhalb von 30 Minuten eine EDIFACT-Datei an diese E-Mail-Adresse	mustermann@gmx.de
  EmpfaengerNachrichtID	Die EmpfaengerNachrichtID repräsentiert ein Konvertierungs-Mapping bei EDICENTER. Die Anfrage EmpfaengerNachrichtID (siehe oben) liefert die Liste aller verfügbaren EmpfaengerNachrichtIDs.	12
  Dateiname	Dateiname der EDI-Datei, die im Nachrichtenrumpf der Anfrage gesendet wird	edidatei.xml

  Diese Name-Wert-Paare werden in der Form

  Parameter1=Wert1&Parameter2=Wert2

  mit vorangestelltem ? an die geforderte URL angehängt.

• Im Nachrichtenrumpf (Body) der Anfrage muss die UNIDOC-Datei übertragen werden.

BEISPIEL-REQUEST

POST https://editest.webedifact.com/Webservice/Konvertiere?Kennwort=1234&EMailAdresse=muster%40mail.de&EmpfaengerNachrichtID=1&Dateiname=edifile.xml HTTP/1.1
Host: editest.webedifact.com
Content-Length: 86063

<?xml version="1.0" encoding="UTF-8" ?>
<transmission xmlns="http://www.edicenter.de/UNIDOC">
<sender>4080700000001</sender>
<recipient>4304449000000</recipient>
<creation_date>2016-11-28</creation_date>
<creation_time>10:10:21</creation_time>
<is_test>false</is_test>
<message_type>INVOIC</message_type>
<version_number>100</version_number>
...
</transmission>

RESPONSE

• Im Erfolgsfall wird ein JSON-Objekt mit 'Status:OK' zurückgegeben:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
     "Status": "OK"
  }
          

• Bei falschen oder fehlenden Anfrage-Parametern (FehlerCode=3):

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "FehlerListe": [
      "Dateiname ist erforderlich",
      "Request-Body ist leer. Erwartet wird eine eine Text-Datei.",
      "'EmpfaengerNachrichtID' Request-Parameter ist falsch: EmpfaengerNachrichtID=342 existiert nicht"
    ],
    "Status": "ERROR",
    "FehlerCode": 3,
    "Meldung": "Falsche oder fehlende Request-Parameter"
  }
  

• Syntax- oder Struktur-XML-Fehler (FehlerCode=4) in der XML-EDI-Datei:

  Beispiel 1:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "FehlerListe": [
      "Data at the root level is invalid. Line 1, position 1."
    ],
    "Status": "ERROR",
    "FehlerCode": 4,
    "Meldung": "XML-Fehler"
  }
  

  Beispiel 2:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "FehlerListe": [
      "The 'creation_time' start tag on line 6 position 2 does not match the end tag of 'creatin_time'. Line 6, position 26."
    ],
    "Status": "ERROR",
    "FehlerCode": 4,
    "Meldung": "XML-Fehler"
  }
  

• Inhaltliche Fehler in der EDI-Datei:

  Beispiel 1:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "Status": "ERROR",
    "FehlerCode": 1,
    "Meldung": "FEHLER: Der Absender ist nicht berechtigt."
  }
  

  Beispiel 2:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "Status": "ERROR",
    "FehlerCode": 1,
    "Meldung": "FEHLER: Die Nachrichtenart in der Datei 'ORDER' stimmt nicht mit der ausgewählten Nachrichtenart 'INVOIC' überein."
  }
  

  Beispiel 3:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  
  {
    "FehlerListe": [
      "The 'http://www.edicenter.de/UNIDOC:creation_time' element is invalid - The value '1010:21' is invalid according to its datatype 'http://www.w3.org/2001/XMLSchema:time' - The string '1010:21' is not a valid Time value.; LineNumber=6; PositionBegin=2;",
      "The 'http://www.edicenter.de/UNIDOC:transmission_number' element is invalid - The value '' is invalid according to its datatype 'http://www.edicenter.de/UNIDOC:ch-1-14' - The actual length is less than the MinLength value.; LineNumber=11; PositionBegin=2;"
    ],
    "Status": "ERROR",
    "FehlerCode": 2,
    "Meldung": "Bei der Validierung der Datei 'edifile.xml' wurde(n) 2 Fehler gefunden. Bitte korrigieren Sie die Fehler, die unten angezeigt werden und laden Sie die Datei erneut hoch."
  }