1. DocProcessor hívása

A DocProcessor segítségével a már dokumentumtípusként definiált struktúrájú információ, dokumentum hozható létre az eBiz rendszerben, ezért a megszokottaktól eltérően az elemi információk nem a hívás paramétereinek a szintjén kerülnek átadásra, hanem betokoztuk őket egy változóba, amelynek az értéke az elemi információkat tartalmazó és előre egyeztetett XML struktúra.

Ezeket az előre egyeztetett információs struktúrákat az eBiz rendszerben dokumentum típusoknak nevezzük.

Ahhoz tehát, hogy létrehozzunk egy információs egységet/dokumentumot az eBiz-ben, az általános autentikációs információkon túl meg kell adnunk a dokumentumtípus nevét, amelyet létre szeretnénk hozni, valamint az adatokat tartalmazó xml-t.

Az authentikáció is kiegészül az eBiz esetében, ugyanis egy egyszerű felhasználónév és jelszó nem elegendő információ az adott dokumentum létrehozásához.

Az API kulcs egy olyan további biztonsági attribútum, amely a SOAP interfész használatához kötelező, továbbá az identity paraméterben tudjuk átadni, hogy az autentikált technikai felhasználóhoz tartozó melyik alanynál kívánjuk létrehozni az adott dokumentumot.

  DocProcessorResponse DocProcessor (
  string apikey, 
  integer identity, 
  string doctype, 
  string method, 
  boolean debug, 
  string postparam1_name, 
  string postparam1_value, 
  string postparam2_name, 
  string postparam2_value, 
  string postparam3_name, 
  string postparam3_value, 
  string postparam4_name, 
  string postparam4_value, 
  string postparam5_name, 
  string postparam5_value
  )
  
  DocProcessor
  •	string apikey
  ApiKey of technical user
  •	integer identity
  Identity of A and B party
  •	string doctype
  Document Type
  •	string method
  Document processing method
  •	boolean debug
  Debug on/off
  •	string postparam1_name
  POST parameter name 1
  •	string postparam1_value
  POST parameter value 1
  •	string postparam2_name
  POST parameter name 2
  •	string postparam2_value
  POST parameter value 2
  •	string postparam3_name
  POST parameter name 3
  •	string postparam3_value
  POST parameter value 3
  •	string postparam4_name
  POST parameter name 4
  •	string postparam4_value
  POST parameter value 4
  •	string postparam5_name
  POST parameter name 5
  •	string postparam5_value
  POST parameter value 5
  DocProcessorResponse
  Return type for DocProcessor - Return structure
  •	boolean success (nillable = false, minoccurs = 1, maxoccurs = 1)
  - True is function is successful
  •	string message (nillable = true, minoccurs = 1, maxoccurs = 1)
  - Debug purpose description
  •	string result (nillable = true, minoccurs = 1, maxoccurs = 1)
  - Result of call (BatchId on asynchronous call)

PARAMÉTEREK

  • apikey: egy kulcs, amely jogosultsági objektumként van a technikai felhasználóhoz rendelve. A SOAP hívás során ennek megadása kötelező.
  • identity: A technikai felhasználóhoz több alany is hozzá lehet rendelve. Ebben a paraméterben adjuk meg azt a Relation ID –t amely összeköti a technikai felhasználót azzal az alannyal, akire vonatkozóan a műveleteket el kívánjuk végezni
  • doctype: a dokumentumtípus neve, amely definiálja a létrehozni kívánt dokumetumot
  • method: A dokumentum microFLOW nevét adjuk, meg, amellyel a azt létre kívánjuk hozni.
  • debug: debug üzenetek megjelenítése
  • param1_name: átadandó 1. számú paraméter neve
  • param1_value: átadandó 1. számú paraméter értéke
  • param2_name: átadandó 2. számú paraméter neve
  • param2_value: átadandó 2. számú paraméter értéke

Kötelezően átadandó paraméterek:

Átadandó érték Magyarázat
param1_name: xmldocument Ezzel jelöljük, hogy a param1 value-ban a dokumentum adatait tartalmazó xml –t fogjuk átadni
param1_value: XML A dokumentum típus által meghatározott xml struktúra az adatokkal
param2_name: xmlparameters Ezzel jelöljük, hogy paramétereket átadó xml állományt adunk át a rendszernek
param2_value: XML parameters struktúrája

Opcionálisan átadandó paraméterek:

Átadandó érték Magyarázat
param3_name: deliverylist Ezzel jelöljük, hogy a value-ban a kézbesítési listát tartalmazó xml-t fogjuk küldeni
param3_value: XML deliverylist struktúrája

VISSZAADOTT ÉRTÉKEK

  • success: 1 ha a process rendben lefutott, 0 ha hibás
  • message: Üzenet és/vagy a szükséges visszaadott érték
  • result:
  • Oldalforrás megtekintése