Common Types

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

ResponseStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
code	Number	státusz kód
messages	List of Message	üzenetek listája

code lehetséges értékei:

Érték	Jelentés
0	sikeres kérés
1	technikai hiba
2	validációs hiba

Message

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
severity	Severity	Az üzenet súlyossága
code	String	Az üzenet egyedi kódja
description	String	Az üzenet szövege
refElement	String	A hibás elemre referencia
refValue	String	Az üzenetet kiváltó mező értéke

Severity lehetséges értékei:

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Érték	Jelentés
ERROR	hiba (technikai status = 1, vagy validációs: status = 2)
WARNING	figyelmeztetés szintű üzenet
INFO	tájékoztató üzenet

ParamsType

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
key	String	Kulcs mező
value	String	Érték
ref	String	Referencia

WS API-n:

Param

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
key	String	Kulcs mező
value	String	Érték
ref	String	Referencia

AttachmentDetail

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
fileName	String	A csatolmány email-beli neve
internalFileName	String	A csatolmány belső rendszerbeli neve (Fájlszerveren így tárolódik)
archivingExpected	Boolean	true esetén archiválódik
certificationExpected	Boolean	true érték esetén a csatolmány aláírásra kerül
contentAvailable	Boolean	true érték esetén a tartalom elérhető
id	Integer	Egyedi azonosító
documentType	String	A csatolmány típusa. Pl. kötvény, stb
objectType	String	A kapcsolódó objektum típusa
objectRef	String	A kapcsolódó objektum azonosítója
attachmentRef	String	A csatolmány azonosítója
properties	List of Property	Egyéb adatok, metaadatok

AttachmentDetail_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
fileName	String	A csatolmány email-beli neve
internalFileName	String	A csatolmány belső rendszerbeli neve (Fájlszerveren így tárolódik)
archivingExpected	Boolean	true esetén archiválódik
certificationExpected	Boolean	true érték esetén a csatolmány aláírásra kerül
contentAvailable	Boolean	true érték esetén a tartalom elérhető
id	Integer	Egyedi azonosító
documentType	String	A csatolmány típusa. Pl. kötvény, stb
objectType	String	A kapcsolódó objektum típusa
objectRef	String	A kapcsolódó objektum azonosítója
attachmentRef	String	A csatolmány azonosítója
properties	List of Property	Egyéb adatok, metaadatok

AttachmentDetail_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
fileName	String	A csatolmány email-beli neve
internalFileName	String	A csatolmány belső rendszerbeli neve (Fájlszerveren így tárolódik)
archivingExpected	Boolean	true esetén archiválódik
certificationExpected	Boolean	true érték esetén a csatolmány aláírásra kerül
contentAvailable	Boolean	true érték esetén a tartalom elérhető
id	Integer	Egyedi azonosító
documentType	String	A csatolmány típusa, Pl. kötvény, stb
objectType	String	A kapcsolódó objektum típusa
objectRef	String	A kapcsolódó objektum azonosítója
attachmentRef	String	A csatolmány azonosítója
uuid	String	A csatolmány UUID-ja
properties	List of Property	Egyéb adatok, metaadatok

AttachmentDetail_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
fileName	String	A csatolmány email-beli neve
internalFileName	String	A csatolmány belső rendszerbeli neve (Fájlszerveren így tárolódik)
archivingExpected	Boolean	true esetén archiválódik
certificationExpected	Boolean	true érték esetén a csatolmány aláírásra kerül
contentAvailable	Boolean	true érték esetén a tartalom elérhető
id	Integer	Egyedi azonosító
documentType	String	A csatolmány típusa, Pl. kötvény, stb
objectType	String	A kapcsolódó objektum típusa
objectRef	String	A kapcsolódó objektum azonosítója
attachmentRef	String	A csatolmány azonosítója
archivedAt	DateTime	Az archiválás időpontja
archiveStatus	String	Archiválási státusz
uuid	String	A csatolmány UUID-ja
properties	List of Property	Egyéb adatok, metaadatok
openedAt	DateTime	Csatolmány megnyitásának időpontja

AttachmentsDetails

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
attachments	List of AttachmentWithoutContent	Csatolmányok

AttachmentsDetails_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
attachments	List of AttachmentWithoutContent_V1	Csatolmányok

AttachmentsDetails_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
attachments	List of AttachmentWithoutContent_V2	Csatolmányok

AttachmentsDetails_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
attachments	List of AttachmentWithoutContent_V3	Csatolmányok

Attachment

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Name	Type	Description	Mandatory
~~internalFileName~~	String (300)	^^DEPRECATED!^^ A csatolmány belső rendszerbeli neve. (Fájlszerveren így tárolódik)
fileName	String (300)	A csatolmány email-beli neve	X
~~relativeFileDirPath~~	String	^^DEPRECATED!^^ A csatolmányt tartalmazó könyvtár relatív elérési útja a fájlszerveren
content	xs:base64Binary	A castolmány byte tömbként
documentType	String (100)	A csatolmány típusa, Pl. kötvény, stb
objectType	String (100)	A kapcsolódó objektum típusa
objectRef	String (100)	A kapcsolódó objektum azonosítója
archivingExpected	Boolean	true esetén a csatolmányt archiválni kell	X
certificationExpected	Boolean	true esetén a csatolmány digitálisan alá lesz írva	X
deleteSourceExpected	Boolean	true esetén a csatolmány a levél kiküldése után törlésre kerül	X
postableWithoutCertificate	Boolean	true érték esetén aláírás nélkül küldhető	X
attachmentRef	String (200)	A csatolmány azonosítója
embeddedXml	String (CLOB)	Beágyazott xml
properties	List of Property	A csatolmányhoz tartozó egyéb adatok, metaadatok

Attachment_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Name	Type	Description	Mandatory
fileName	String (300)	A csatolmány email-beli neve	X
content	xs:base64Binary	A castolmány byte tömbként
documentType	String (100)	A csatolmány típusa, Pl. kötvény, stb
objectType	String (100)	A kapcsolódó objektum típusa
objectRef	String (100)	A kapcsolódó objektum azonosítója
archivingExpected	Boolean	true esetén a csatolmányt archiválni kell	X
certificationExpected	Boolean	true esetén a csatolmány digitálisan alá lesz írva	X
deleteSourceExpected	Boolean	true esetén a csatolmány a levél kiküldése után törlésre kerül	X
postableWithoutCertificate	Boolean	true érték esetén aláírás nélkül küldhető	X
attachmentRef	String (200)	A csatolmány azonosítója
embeddedXml	String (CLOB)	Beágyazott xml
properties	List of Property	A csatolmányhoz tartozó egyéb adatok, metaadatok

ArchiveStatusList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Name	Type	Description
archiveStatus	String (300)	A csatolmány email-beli neve

DeliveryStatusList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Name	Type	Description
deliveryStatus	String (300)	A csatolmány email-beli neve

MessageChannelList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Name	Type	Description
messageChannel	String (300)	A csatolmány email-beli neve

Property-k

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

• Csatolmányonként az archivingExpected paraméterrel lehetséges definiálni, mi történjen kiküldés után a csatolt dokumentummal: tárolja le a hammy a DMS-ben, vagy törlődjön.

• A file-hoz tartozhatnak property-k. Ha DMS-ben tárolás szükséges akkor ezen property-k tartalmazzák a file metaadatait. Minden property-nél jelezni kell, hogy ő metaadat-e, vagy sem. A nem metaadat property-nek akkor van értelme, ha beletesszük a kiküldendő email szövegébe.

• A PDF csatolmányok digitális aláírással láthatók el, ezt a certificationExpected paraméter szabályozza.

Csatolmány tartalmát jelenleg háromféle módon lehet beküldeni a Hammy-nek:

1. a content mezőben, BASE64 kódolt formában.
2. a csatolmányt fájlszerveren tárolva. A fájl elérési útját kétféleképpen lehet megadni
   1. ^^DEPRECATED!^^ a relativeFileDirPath és internalFileName mezőkkel megadva. (elérési út: ${fileserver_basedir}/relativeFileDirPath/internalFileName)
   2. A fájl relatív elérési útját a property listában a RELATIVE_FILE_PATH kulccsal megadva. Értéke ebben a módban ugyanaz lenne mint az i. módban a /relativeFileDirPath/internalFileName.
3. a csatolmányt DMS-ben tárolva, a documentum egyedi DMS-beli azonosítóját a csatolmány property listájában a DMS_DOCUMENT_ID, valamint a DMS_NODE_ID kulcsú paraméterekkel megadva.

A properties listában az ATTACHMENT_SOURCE kulcsú adat megadása kötelező. Lehetséges értékei a következők:

Érték	Jelentés
INLINE	a csatolmány tartalmát az xml content elemében, base64 kódolva küldik be
FS	fájlszerverről töltjük le a csatolmány tartalmát
DMS	a csatolmány tartalma a Document Management System-ből kerül lekérdezésre

PropertiesType

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

JSON API-n:

Name	Type	Description
key	String (100)	Az adat neve.
value	String (400)	Az adat értéke.
valueType	String (30)	Az érték típusa (INT, LONG, BOOLEAN, DATETIME, DATE, STRING, TEXT)
index	Integer	Több azonos kulcsú érték indexelésére szolál
isMetaData	Boolean	Flag, amely jelzi, hogy az adat metaadat. Értéke true vagy false

WS API-n:

Name	Type	Description
key	String (100)	Az adat neve.
value	String (400)	Az adat értéke.
valueType	String (30)	Az érték típusa (INT, LONG, BOOLEAN, DATETIME, DATE, STRING, TEXT)
index	Integer	Több azonos kulcsú érték indexelésére szolál
isMetaData	Boolean	Flag, amely jelzi, hogy az adat metaadat. Értéke true vagy false

Filter

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
field	String	Mező neve. Jelenleg csak MESSAGE_TYPE lehet
operator	String	Operátor. Jelenleg csak EQUALS lehet
value	String	A mező értéke ezzel kell megegyezzen

Dimensions

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

A dimenzió neve MESSAGE_TYPE és STATUS lehet. Az értéke (value mező) csak a válaszban szerepel.

Mező	Típus	Megjegyzés
name	String	dimenzió kódja
value	String	dimenzió értéke

StatValues

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
name	String	Az érték típusa (pl. TOTAL, AVG)
value	double	Az érték

Statistics

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
fromDate	xs:dateTime	Kezdő dátum
toDate	xs:dateTime	Vég dátum
dimensions	List of Dimensions	Az eredményhez tartozó dimenziók
values	List of StatValues	Értékek listája

Batch

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
id	Integer	A batch belső azonosítója
rootId	Integer	A batch egyedi azonosítója
name	String	A batch neve
requestType	String	A batch típusa (nyomtatvány azonosító)
channel	String	A batch kézbesítési módja (email, posta, archiválás)
description	String	A batch-hez tartozó leírás
totalRequests	Integer	A batch-hez tartozó kérések száma
createdAt	Date	A létrehozás dátuma
enabledAt	Date	Az engedélyezés dátuma. Ha NULL akkor nem engedélyezett a batch
createdAt	Date	A befejezés dátuma
status	String	A batch státusza

status lehetséges értékei: NEW, ENABLED, CANCELLED

Request

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
requestId	Integer	A kérés egyedi azonosítója
requestType	String	Kérés típusa, NULL esetén mindenre illeszkedik
direction	String	Kérés iránya (Postai vagy Email)
status	String	A kérés státusza
recipientName	String	A címzett neve, case insensitive, NULL esetén minden illeszkedik
recipientEmail	String	A címzett email címe, case insensitive, NULL esetén mindne illeszkedik
policyNo	String	A szerződésszám, amennyiben NULL, minden illeszkedik
fileNames	Array of String	A kéréshez tartozó filenevek listája

direction lehetséges értékei: POST, EMAIL

status lehetséges értékei: PREPARED, CANCELLED, BATCHED, NEW, SENT, FETCHED, DONE, ERROR, BOUNCED

QueueName

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
queueName	String	A sor neve

Queue

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
name	String	A sor neve
size	Integer	A sor mérete

QueueProperty

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
key	String	Az adat neve
value	String	Az adat értéke
ref	String	Az adat referenciája

QueueManager

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
id	String	Azonosító ID
time	dateTime	Időpont
queues	List of Queue	Sorok neve

Role

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
role	String	A felhasználói szerepkör

ConfigKey

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
configKey	String	Konfigurációs kulcs

ItemId

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
itemId	Integer	CG_ITEM azonosító

JmsMessageId

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
jmsMessageId	String	JMS Message azonosító

TaskChainWM

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
name	String	A TaskChain neve
description	String	Leírás
status	String	A task chain státusza
queueName	String	A sor neve
errorQueueName	String	Az errorQueue neve

Parameter

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
key	String	kulcs
configValue	String	Az adatbázisban szereplő állapot érték
runningValue	String	A tényleges érték
description	String	A paraméter leírása

NodeId

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
nodeId	String	Node azonosító

Node

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
id	String	A node azonosítója
nodeType	String	A node típusa, master vagy slave
nodeTime	DateTime	Az információk lekérdezésének ideje
nodeProfile	String	Melyik profil alapján működik
modules	List of Module	A modulok listája

Module

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
moduleName	String	A modul neve
configValue	String	Az adatbázisban szereplő állapot érték
runningValue	String	A tényleges érték
description	String	A paraméter leírása

UserGroup

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
userGroup	String	Felhasználói csoport

CGParam

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
id	Integer	Elsődleges azonosító
key	String	A paramétert azonosító kulcs
value	String	A paraméter értéke
objectType	String	A paraméter hatókör típusa
objectId	String	A paraméter hatókör azonosítója
kind	String	A paraméter fajtája

CGParamsWithSubParams

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
param	String CGParam	A fő paraméter
subParams	List of CGParamWithSubParams	A fő paraméterhez tartozó alparaméterek

CGParamList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
cgParam	List of CGParam	CGParam lista

Event

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
eventSource	String	Az esemény forrása
eventName	String	Az esemény neve
eventNameDesc	String	Az esemény leírása
eventType	String	Az esemény típusa
eventParams	String	Az esemény paraméterei
taskChain	String	Task chain neve
taskChainDesc	String	Task chain leírása
trace	String	A hiba leírásai
createdAt	dateTime	A létrehozás dátuma

EventList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
event	List of Event	Event lista

TMessage_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
actualStatus	String	Az üzenet aktuális státusza
statusLastChangedAt	dateTime	A státusz utolsó módosulásának ideje
messageType	String	Az üzenet típusa
recipientName	String	Az ügyfél neve
recipientAddress	String	Az ügyfél e-mail címe
messageId	Integer	Az üzenet adatbázisbeli azonosítója
archivingExpected	Boolean	'true' érték esetén a levél tárgya és szövege archiválódik
partnerRef	String	Partner azonosító
createdAt	dateTime	A létrehozás dátuma
sentAt	dateTime	A küldés ideje
bouncedAt	dateTime	A levél visszapattanásának ideje
boundReasonCode	String	Az üzenet visszapattanásának oka
boundReasonDescription	String	A visszapattanás okának leírása
properties	Property	Az üzenethez tartozó egyéb adatok, metaadatok
attachments	AttachmentsDetails_V1	Az üzenethez tartozó csatolmányok adatai
permissionShowList	List of String
permissionListList	List of String
canShow	Boolean

TMessage_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
actualStatus	String	Az üzenet aktuális státusza
statusLastChangedAt	DateTime	A státusz utolsó módosulásának ideje
messageType	String	Az üzenet típusa
recipientName	String	Az ügyfél neve
recipientAddress	String	Az ügyfél e-mail címe
messageId	Integer	Az üzenet adatbázisbeli azonosítója
archivingExpected	Boolean	'true' érték esetén a levél tárgya és szövege archiválódik
partnerRef	String	Partner azonosító
createdAt	DateTime	A létrehozás dátuma
sentAt	DateTime	A küldés ideje
bouncedAt	DateTime	A levél visszapattanásának ideje
movedToArchiveAt	DateTime	A levél archiválásának ideje
boundReasonCode	String	Az üzenet visszapattanásának oka
boundReasonDescription	String	A visszapattanás okának leírása
channel	String	Az üzenet csatornája
uuid	String	Az üzenet UUID-ja
properties	Property	Az üzenethez tartozó egyéb adatok, metaadatok
attachments	AttachmentsDetails_V2	Az üzenethez tartozó csatolmányok adatai
permissionShowList	List of String
permissionListList	List of String
canShow	Boolean

TMessage_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

1. Megszűnt a messageId mező, és megjelent helyette az uuid mező, ami az üzenet uuid-ját tárolja
2. Megjelent a msgArchiveStatus mező, ami az üzenet archiválási státuszát tárolja
3. Megjelent az aggregatedArchiveStatus mező, ami az üzenet aggregált archiválási státuszát tárolja
4. Megjelent az archivedAt mező, ami az archiválás dátumát tartalmazza
5. Megelent az errorEventId mező, ami a hibaesemény azonosítóját tartalmazza
6. Megelent az errorEventCode mező, ami a hibaesemény kódját tartalmazza
7. Megelent az errorEventName mező, ami a hibaesemény nevét tartalmazza
8. Megelent az errorEventDescription mező, ami a hibaesemény leírását tartalmazza
9. Megelent a recipientPhoneNumber mező a címzett telefonszámát tartalmazza
10. Megelent a fromPhoneNumber mező, ami a feladó telefonszámát tartalmazza
11. Megelent a recipientPSID mező, ami a címzett facebook azonosítóját tartalmazza
12. Megelent a fromPageAccessToken mező, ami a feladó Page Access Token-jét tartalmazza
13. Megelent az openedAt mező, ami az üzenet megnyitásának időpontját tartalmazza
14. Megelent a noticeOpenedAt mező, ami az üzenet megnyitásának időpontját tartalmazza
15. Megelent a direction mező, ami az üzenet irányát (Bejövő/Kimenő) tartalmazza

Mező	Típus	Megjegyzés
actualStatus	String	Az üzenet aktuális státusza
msgArchiveStatus	String	Az üzenet archiválási státusza
aggregatedArchiveStatus	String	Az üzenet aggregált archiválási státusz
statusLastChangedAt	DateTime	A státusz utolsó módosulásának ideje
messageType	String	Az üzenet típusa
recipientName	String	Az ügyfél neve
recipientAddress	String	Az ügyfél e-mail címe
messageId	Integer	Az üzenet adatbázisbeli azonosítója
archivingExpected	Boolean	'true' érték esetén a levél tárgya és szövege archiválódik
archivedAt	DateTime	Partner azonosító
partnerRef	String	Partner azonosító
createdAt	DateTime	A létrehozás dátuma
sentAt	DateTime	A küldés ideje
bouncedAt	DateTime	A levél visszapattanásának ideje
movedToArchiveAt	DateTime	A levél archiválásának ideje
boundReasonCode	String	Az üzenet visszapattanásának oka
boundReasonDescription	String	A visszapattanás okának leírása
channel	String	Az üzenet csatornája
uuid	String	Az üzenet UUID-ja
errorEventId	String	Az üzenethez tartozó esemény azonosítója
errorEventCode	String	Az üzenethez tartozó esemény kódja
errorEventName	String	Az üzenethez tartozó esemény neve
errorEventDescription	String	Az üzenethez tartozó esemény leírása
recipientPhoneNumber	String	A címzett telefonszáma
fromPhoneNumber	String	A feladó telefonszáma
recipientPSID	String	A címzett facebook azonosítója
fromPageAccessToken	String	A címzett page access token-je
permissionShowList	List of String	Azon felhasználók listája, akik olvashatják az üzenethez tartozó sablont
permissionListList	List of String	Azon felhasználók listája, akik módosíthatják az üzenethez tartozó sablont
canShow	Boolean	'true' érték esetén a felhasználónak van joga, hogy az üzenet megjelenjen számára a felületen
openedAt	DateTime	Az üzenet megnyitásának időpontja
noticeOpenedAt	DateTime	Az értesítő e-mail megnyitásának időpontja
direction	String	Az üzenet iránya (Bejövő/Kimenő)
properties	Property	Az üzenethez tartozó egyéb adatok, metaadatok
attachments	AttachmentsDetails_V3	Az üzenethez tartozó csatolmányok adatai
clikcedLinks	list of ClickedLink	Az üzenethez kattintott linkek csatolmányok adatai

ClickedLink

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Az üzenethez (TMessage) tartozó kattintott link tulajdonságai

Mező	Típus	Megjegyzés
uuid	String	A linkhez tartozó UUID
ipAddress	String	A linkhez tartozó IP cím
clickedAt	DateTime	A link kattintásának időpontja
firstClick	DateTime	A link első kattintásának időpontja
mailLinkUuid	String	Email link UUID
mailLinkTitle	String	Email link cím
mailLinkRealUrl	String	Email link abszolút URL

AttachmentWithContent

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail	A csatolmány adatai
content	xs:base64Binary	A csatolmány tartalma base64 kódolt formában

AttachmentWithContent_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V2	A csatolmány adatai
content	xs:base64Binary	A csatolmány tartalma base64 kódolt formában

AttachmentWithContent_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V2	A csatolmány adatai
content	xs:base64Binary	A csatolmány tartalma base64 kódolt formában

AttachmentWithContent_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V3	A csatolmány adatai
content	xs:base64Binary	A csatolmány tartalma base64 kódolt formában
openedAt	DateTime	A csatolmány megnyitásának időpontja

AttachmentWithoutContent

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail	A csatolmány adatai

AttachmentWithoutContent_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V2	A csatolmány adatai

AttachmentWithoutContent_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V2	A csatolmány adatai

AttachmentWithoutContent_V3

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
details	AttachmentDetail_V3	A csatolmány adatai
openedAt	DateTime	A csatolmány megnyitásának időpontja

subscription

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
recipientGroupDescription	String	Ügyféllista (Címlista) leírás
recipientGroupId	Integer	A címlista adatbázisbeli azonosítója
recipientGroupName	String	A címlista neve
subscribed	Boolean	Feliratkozott-e

MessageEvent

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
eventName	String	Az esemény neve
eventCode	String	Az esemény kódja
eventDate	Timestamp	Az esemény időpontja
params	List of EventParam	Egyéb paraméterek

EventParam

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
key	String	Esemény paraméter azonosító
stringValue	String	Paraméter értéke string érték esetén
numberValue	Number	Paraméter értéke szám érték esetén
dateValue	Date	Paraméter értéke dátum érték esetén

EventParamsList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
key	String	Esemény paraméter azonosító
stringValue	String	Paraméter értéke string érték esetén
numberValue	Number	Paraméter értéke szám érték esetén
dateValue	Date	Paraméter értéke dátum érték esetén

MessageType

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
messageTypeCode	String	A üzenettípus kódja
description	String	A üzenettípus leírása
status	MessageTypeStatus	A üzenettípus státusza
createdAt	Timestamp	A létrehozás dátuma
updatedAt	Timestamp	Utolsó módosítás dátuma
layoutId	String	Elhelyezés azonsító ID
templateHandlingCategory	Integer	Template kategoria
templateHandlingCategoryName	String	Template kategoria neve
templateKind	TemplateKind	Template típus
templateSubkind	String	Template altípus	Minden API-n V3-tól.
permissionShowList	List of String	Láthatósági engedélyek
permissionListList	List of String	Engedélyek listája
canShow	Boolean	Látható-e?
uuid	String	Az üzenettípus UUID-ja
creationMode	String	Az üzenettípus létrehozásának módja. (MANUAL, COPY, IMPORT)	V4-től.
relatedUuid	String	Ha a creationMode COPY vagy IMPORT, akkor töltve van a kapcsolódó UUID-val.	V4-től.

MessageTypeStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

MessageTypeStatus String típusú mező, lehetséges értékei:

Érték	Jelentés
ENABLED	a Hammy befogadja a kéréseket, és ki is küldi
DISABLED	nem fogadja be a kérést, hanem hibát dob
SUSPENDED	befogadja a kéréseket, de várakoztatja őket. Engedélyezés után folytatja a kiküldést
EMERGENCY_STOPPED	belső hiba miatt a üzenettípus küldése automatikusan leállt

TemplateKind

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

TemplateKind String típusú mező, lehetséges értékei:

Érték	Jelentés
normal	E-mail sablon.
notice	Értesítő e-mail sablon.
supervisor	Supervisor e-mail sablon.
statistics	Statisztika e-mail sablon.
campaign	Kampány e-mail sablon.
generated	Dokumentum generálásái sablon.
fragment	Dokumentum töredék sablon. (Összetett sablonokhoz használható.)
sms	SMS sablon.
facebook	Facebook üzenet sablon.

Asset

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
uuid	String	Az asset azonosítója
assetId	Integer	Az asset azonosítója az adatbázisban
category	String	Az asset kategóriája
description	String	Az asset leírása
fileName	String	Az asset fájl neve
type	AssetType	Az asset típus	Minden API-n V2-től.
data	xs:base64Binary	Az asset byte[]-ként	RS és WS API-k esetén. JSON API esetén multipart kérésben jön.
mimeType	String	Az asset mime típusa
width	Integer	Az asset új szélessége (pixelben)	Minden API-n V3-tól
height	Integer	Az asset új magassága (pixelben)	Minden API-n V3-tól
aspectRatio	String	Az asset új képaránya (pl. 16:9)	Minden API-n V3-tól

JSON API esetén asset létrehozáshoz multipart/mixed vagy multipart/form-data content-type-ú kérést kell küldeni. A fenti objektumot az asset nevű részben (part) kell küldeni application/json -ként, és nem tartalmazhatja a data mezőt. A data mező tartalma külön, egy asset_data nevű, base64 kódolású, application/octet-stream content-type-ú részben (part) küldendő.

AssetType

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Asset típusa

Érték	Jelentés
IMAGE	Fix csatolmány
LOGO	Vízjel, logó
ATTACHMENT	Sablonokban elhelyezhető asset.

TemplateHandlingCategory

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
id	Integer	A template azonosítója
uuid	String	A template azonosítója
categoryName	String	A kategoria neve
replaceLinks	Boolean	Helyetesítő link
assetDeliveryMode	String	Átviteli mód
renderMarkdown	Boolean	Hibás?
erHandlingCategory	ErHandlingCategory	Error kezelési kategoria

ErHandlingCategory

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
id	Integer	Error kezelési azonosító
name	Sting	Error neve
failureLimitPerMin	Integer	Maximum megengedett hiba per perc
responsibles	String	Felelős
punishmentMins	Integer	Büntetés

Layout

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
uuid	String	A layout azonosítója
id	Integer	A layout azonosítója
name	String	A layout neve
description	String	A layout leírása
createdAt	Timestamp	A létrehozás dátuma
htmlContent	String	A HTML tartalom

TemplateVersion

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás	Template API verzió
uuid	String	A template azonosítója.	WS V1 kivételével mindenhol.
versionNumber	Number	A verzió száma.
description	String	A verzióhoz tartozó komment.
status	TemplateVersionStatus	A template verzió sátusza.
subject	String	Az email subject-je.
actual	Boolean	Aktuális?
htmlBody	String	Az üzenet html szövege.
plainTextBody	String	Az üzenet plain text szövege.
noticeTemplateCode	String	Értesítő template kódja.
noticeTemplateVersionNum	String	Értesítő template verziója.
createdAt	Timestamp	A létrehozás dátuma.
updatedAt	Timestamp	Utolsó módosítás dátuma.
generationItemUUID	String	Generálási azonosító.
lastActivatedAt	Timestamp	Az az időpont, amikor utoljára aktuális állapotba került a verzió	V4-től.
lastActivatedBy	String	A felhasználó neve, aki utoljára aktuális állapotba tette a verziót.	V4-től.
relations	TemplateVersionRelation	Template verzió Kapcsolatok.	V3-tól.
creationMode	String	Template verzió létrehozásának módja. (COPY, MANUAL, IMPORT)	V4-től.
relatedUuid	String	Ha a creationMode COPY vagy IMPORT, akkor töltve van a kapcsolódó UUID-val.	V4-től.

JSON API esetén asset létrehozáshoz multipart/mixed vagy multipart/form-data content-type-ú kérést kell küldeni. A fenti objektumot a template_version nevű részben (part) kell küldeni application/json -ként. A sablon verzió bináris tartalma külön, egy template_version_body nevű, base64 kódolású, application/octet-stream content-type-ú részben (part) küldendő.

A fileName mező több módon is töltődhet. Ezek prioritás szerinti csökkenő sorrendben a következők:

1. A fileName mezőben explicit megadva

2. A template_version_body rész Content-Disposition fejlécének filename paraméteréből

3. Örökli az előző verzióról

TemplateVersionRelation

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Template verzió kapcsolatok. Összetett template verziók esetén használandó. Olyan verziókra tartalmaz hivatkozásokat, amelyek ennek a verziónak a teljes értékű használatához szükségesek. (Hivatkozás fejléc, lábléc, záradék, aláírás template-ekre.)

Mező	Típus	Leírás	Template API verzió
name	String	Hivatkozás azonosító a template-ben.	Minden API-n V3-tól.
description	String	Kapcsolat leírása.	Minden API-n V3-tól.
relatedMessageType	String	Kapcsolódó üzenet típus kódja.	Minden API-n V3-tól.
relatedTemplateVersion	Number	A verzió száma.	Minden API-n V3-tól.

A name mező értéke meg kell hogy egyezzen a template verzióban szereplő külső hivatkozásban használt azonosító értékével.

Ha a relatedTemplateVersion nincs kitöltve, akkor a kapcsolat a legutolsó élesített template verzióra vonatkozik.

TemplateVersionStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

A TemplateVersionStatus String típusú mező, lehetséges értékei:

Érték	Jelentés
OLD	már nem éles verzió
ACTUAL	élesített template verzió
DRAFT	még nem élesített verzió

TaskChainElement

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
key	String	Az adat azonosító kulcs
value	String	Az adat értéke
valueType	String	Az adat típusa
description	String	Az adat leírása

CGErrorType_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
id	Number	A hiba típus azonosítója
errorName	String	A hiba típus neve
errorClass	String	A hiba típus osztálya
errorType	String	A hiba típus fajtája. Lehetséges értékek: F,E,W
errorHandlingCategory	Number	A hiba kezelő kategória azonosítója.

A hiba típusok fajtái:

• F: Fatal, súlyos hiba.
• E: Error, normál hiba.
• W: Warning, figyelmeztetés.

CGErrorType_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
id	Number	A hiba típus azonosítója
errorName	String	A hiba típus neve
errorClass	String	A hiba típus osztálya
errorType	String	A hiba típus fajtája. Lehetséges értékek: F,E,W
errorHandlingCategory	Number	A hiba kezelő kategória azonosítója.
errorMessage	String	Hibaüzenet

JobStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

A JobStatus String típusú mező lehetséges értékei:

• WAITING: végrehajtásra vár.
• STARTED: elindult.
• FINISHED: sikeresen lezárult.
• FAILED: sikertelenül lezárult.
• CANCELLED: törölt.

RequestMeta_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
clientHashKey	String	A hívó egyedi kódja
userName	String	A hívó felhasználóneve
params	Param_V1)	Egyéb paraméterek

ResponseStatus_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
code	Number	státusz kód
messages	MessageList_V1	üzenetek

Params_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
param	Array of Param_V1	Egyéb paraméterek listája

RequestMeta

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója. Előre generált érték, az üzemeltetéstől tudja megszerezni
userName	String	A webszolgáltatást hívó felhasználó

TimestampMode

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

TimestampMode String típusú mező, lehetséges értékei:

Érték	Jelentés
INTERNAL	A belső szerver óráját felhasználó, nem hiteles időbélyeg
EXTERNAL	Külső szolgáltatótól kért, hiteles időbélyeg

SignImage

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
image	xs:base64Binary	A kép állomány byte tömbként, base64 kódolva
alignment	Alignment	A kép elhelyezkedées. Ha ez adott, posX és posY érték ignorálva
posX	String(10)	A kép abszolút pozíciója, x koordináta értéke
posY	String(10)	A kép abszolút pozíciója, y koordináta értéke

Alignment

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Alignment String típusú mező, lehetséges értékei:

Érték	Jelentés
LOWER_LEFT	Aláírási kép a bal alsó sarokba
LOWER_RIGHT	Aláírási kép a jobb alsó sarokba
UPPER_LEFT	Aláírási kép a bal felső sarokba
UPPER_RIGHT	Aláírási kép a jobb felső sarokba

ErrorQueue_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
queueName	String	Sor neve
messageType	String	Üzenet típusa
errorMessage	String	Hibaüzenet
errorMinDate	Date	Error kezdeti dátum
errorMaxDate	Date	Error vég dátum
count	Integer	Mennyiség
skippedError	Boolean	Kihagyott error
skippedErrorType	CGErrorType_V1	Kihagyott error típusa
skippedParamList	CGParam	Kihagyott meta adatok

ErrorQueue_V2

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
queueName	String	Sor neve
messageType	String	Üzenet típusa
errorMessage	String	Hibaüzenet
errorMinDate	Date	Error kezdeti dátum
errorMaxDate	Date	Error vég dátum
count	Integer	Mennyiség
skippedError	Boolean	Kihagyott error
skippedErrorType	CGErrorType_V2	Kihagyott error típusa
skippedParamList	CGParam	Kihagyott meta adatok
resendRoundLimit	Integer	Automatikus újraküldések száma
resendOverflowAction	String	Eldobás maxinális újraküldések számának túllépése esetén?
autoResendTimeout	Integer	Automatikus újraküldés előtt eltelt idő

ErrorQueueItem_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
queueName	String	Sor neve
messageType	String	Üzenet típusa
recipientAddress	String	Címzett címe
errorDate	Date	Error dátum
errorMessage	String	Hibaüzenet
jmsMessageId	String	JMS üzenet ID
itemId	Integer	Elem azonosító ID

Param_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
key	String	Kulcs mező
value	String	Érték
ref	String	Referencia

MessageDirectionList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
direction	String	Üzenet iránya

JobInfo

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
jobId	Integer	A job azonosítója
jobStatus	String	A job státusza
jobClass	String	A job osztálya
createdAt	DateTime	A job létrehozásának időpontja
startedAt	DateTime	A job végrehajtásának kezdete
finishedAt	DateTime	A job befejezésének időpontja
resultDescription	String	Eremény leírása
progressPct	String	A százalékos végrehajtottság
jobParams	List of Params	A job egyedi paraméterei, kulcs és érték párok

EventName

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

A EventName String típusú mező, lehetséges értékei:

Érték	Jelentés
EMAIL_SENT	Email elküldve
EMAIL_BOUNCED	Email visszapattant
EMAIL_ARCHIVED	Email archiválva
LEISURE	Parkoló
LEISURE_OVERFLOWED	Parkoló túlcsordulás
ERROR	Error
EMAIL_OPENED	Email megnyitva
LINK_CLICKED	Linkre rákattintva

PropertyModification

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Egy Property módosítását leíró entitás. A módosítás lehet létrehozás (CREATE), változtatás (UPDATE) és törlés (DELETE).

Mező	Típus	Leírás
action	String	A módosítás jellege (CREATE/UPDATE/DELETE)
property	Property	A módosítandó property

A módosítandó property-nek a művelethez megfelelően kell az adatokat tartalmaznia:

• CREATE és UPDATE esetén minden kívánt mező beküldése szükséges. Amennyiben nem érkezik meg egy mező, annak az értéke null lesz. (UPDATE esetén így felülíródik, akkor is ha már rendelkezett értékkel korábban)
• DELETE esetén elegendő a property kulcsát beküldeni (hiszen ezzel azonosítható)

TemplateStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
status	List of String	Státuszok

TemplateKindList

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
templateKind	List of String	Típusok

A MessageTypes kilistázásánál használt típus szűrők gyűjteménye.

ExportMessage

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
messageType	MessageType	Üzenet típusa
templateHandlingCategory	TemplateHandlingCategory	Template kezelési kategoria
layout	Layout	Elhelyezés
templateVersionList	List of TemplateVersion	Template verzióinak listája
assetList	List of Asset	Csatolmányok listája
cgParamList	List of CGParam	CGParam listája
customData	String	Egyedi adat

Organization

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
uuid	String	Organizáció UUID azonosítója
name	String	Organizáció neve

VariableConstraint

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Sablon változóhoz tartozó megkötés. Lényege, hogy a DOCX alapú sablonok általi generáláskor a sablonban található változókra különböző megkötéseket lehet velük definiálni. Három féle megkötés típus van ami lényegében a szemantikájukat határozza meg. Ezen kívül a megkötéseknek operátora van, ami azt mondja meg, hogy mi is a megkötés fajtája (pl. adott hosszra megkötés).

Egy megkötés a következő típusokkal rendelkezhet:

• VALID - Egy adott változó értékére vonatkozó kényszer
• MANDATORY - Egy hivatkozott (másik) változó értékétől függően életbelépő kötelezőségi kényszer
• ACTIVE - Nem játszik szerepet a validációban, a felület számára szükséges jelentéssel bír

Tehát a validáció szempontjából lényeges két típus a VALID és MANDATORY, ezekre a követekző operátorok értelmezhetőek:

• REGEX - Egy meghatározott reguláris kifejezésnek kell megfelelni a változónak
• MINLENGTH - Minimum a megadott hosszúsággal kell rendelkezni a változónak
• MAXLENGTH - Maximum a megadott hosszúsággal kell rendelkezni a változónak
• EXACTLENGTH - Pontosan egy megadott hosszúsággal kell rendelkezni a változónak
• MINDATE - Egy adott dátumnál újabbnak (vagy akkorinak) kell lenni a változónak
• MAXDATE - Egy adott dátumnál nem lehet későbbi a változó
• EQUAL - Meg kell egyezni a változónak a megadott értékkel

A kényszerek sablon változókhoz tartoznak, azonban a MANDATORY típus esetén a kényszerben meg van jelölve egy hivatkozott változó és a kényszer lényege, hogy az eredeti változó akkor válik kötelezővé, ha a hivatkozott változó értéke kielégíti a kényszert.

Mező	Típus	Leírás
key	String	A megkötés egyedi azonosítója (kulcsa)
operator	String	A megkötés operátora
value	String	A megkötés értéke (pl. egy dátum)
errorMessage	String	A megkötéshez tartozó hibaüzenet
type	String	A megkötés típusa
variable	String	Esetlegesen hivatkozott változó kulcsa

MessageStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Egy enum, ami meghatározza, hogy az üzenet milyen státusszal rendelkezhet. Értékkészlete a következő:

• NEW - Újonnan létrejött üzenet, még nincs elküldve
• SENT - El lett küldve az üzenet
• ERROR - Hiba lépett fel az üzenet feldolgozása során
• FAILED - Az üzenet ki lett küldve és visszapattant
• LEISURE - Az üzenet várakozik (parkoló pályán van)
• LEISURE_OVERFLOWED - Az üzenet túl sokszor került már újbóli feldolgozásra a várakozásból. Emiatt automatikusan nem próbálkozik tovább a rendszer, manuális beavatkozással lehet továbblépni.
• CANCELLED - Az üzenet vissza lett vonva - törölve
• SUSPENDED - Az üzenet feldolgozása fel lett függesztve
• BLOCKED - Az üzenet kiküldése blokkolva van az adott email címre
• DELIVERY_SKIPPED - Az üzenet kiküldése mellőzve lett
• MOVED - Az üzenet másodlagos tárra került
• SCHEDULED - Az üzenet ütemezett kiküldésre várakozik
• SUCCESS - Az üzenet feldolgozása sikeresen befejeződött
• REGULATED - Az üzenet forgalom szabályozásra került

CheckEmailAddressStatus

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Egy enum, ami meghatározza, hogy az email cím lekérdezésnél milyen státusszal rendelkezhet az entitás. Értékkészlete a következő:

• EMAIL_NO_INFO - A címhez nem található üzenet
• EMAIL_WRONG_ADDRESS - Érvénytelen email cím
• EMAIL_SEND_IN_PROGRESS - A címhez tartozó üzenet kiküldés alatt van (NEW státuszú)
• EMAIL_SENT - A címhez tartozó üzenet már ki lett küldve (SENT státuszú)
• EMAIL_OPENED - A címhez tartozó üzenet már meg lett nyitva (van megnyitás esemény)
• EMAIL_LINK_CLICKED - A címhez tartozó üzenetben lévő link valamelyikére már kattintottak (van link kattintás esemény)
• EMAIL_BOUNCED - A címhez tartozó üzenet ki lett küldve és visszapattant (FAILED státuszú)
• EMAIL_FAILED - A címhez tartozó üzenet feldolgozása során hiba lépett fel (ERROR státuszú)
• EMAIL_UNKNOWN_STATUS - Akkor kerül beállításra, ha az üzenet nem SENT/NEW/FAILED/ERROR státusszal rendelkezik

ReportedTemplateVariable_V1

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Leírás
variable	String	változó neve.
valueType	String	változó típusa.
positionInReports	Integer	A változó pozíciója a riportokban.

ClientPreview

Elavult dokumentáció

A közös típusok frissített dokumentációja itt található. Ez az oldal csak a Doky dokumentáció kompatibilitása miatt maradt meg.

Mező	Típus	Megjegyzés
uuid	String	Client uuid
name	String	Client név