Template API V4
HammyTemplate4API WSDL letöltése
List assets
Ebben a verzióban nem változott.
Show asset
Ebben a verzióban nem változott.
Show asset content by UUID
Ebben a verzióban nem változott.
Show asset content
Kép tartalmának lekérése filenév vagy UUID alapján.
REST API
Ez a funkció csak REST API-n hívható, Web service-n a Show asset a tartalmat is visszaadja.
REST API
Kérés
GET hammy/json/template/v4/assets/content
| Paraméter | Típus | Leírás |
|---|---|---|
| fileName | String | A keresett file neve. |
| uuid | String | A keresett kép UUID-ja. |
Ha mind az azonosító, mind a fájlnév szerepel paraméterként, akkor az esetleges inkonzisztencia lehetősége miatt mindig validációs hibát kapunk.
Válasz
A képet a body Byte [ ]-ként tartalmazza, a megfelelő MIME type-ot a header.
Minta
GET /hammy/json/template/v4/assets/{{assets.id}}/content?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
GET /hammy/json/template/v4/assets/content?fileName=header.jpg
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: image/png
Content-Disposition: attachment; filename*=UTF-8''{{filename}}
[BINÁRIS TARTALOM]
Create asset
Ebben a verzióban nem változott.
Delete asset
Törli a megadott képet.
Web service API
Kérés
| Mező | Típus | Leírás | Kötelező |
|---|---|---|---|
| assetUuid | String | A törlendő kép UUID-ja. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Mező | Típus | Leírás |
|---|---|---|
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:deleteAsset>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<assetUuid>1234uuid</assetUuid>
</request>
</v4:deleteAsset>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:deleteAssetResponse>
<response/>
</ns3:deleteAssetResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/template/v4/assets/{{uuid}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A törlendő asset UUID-ja. |
| Paraméter | Típus | Leírás |
|---|---|---|
| disableSafeDelete | Boolean | Biztonságos törlés kikapcsolása. |
REST API esetében már lehetőség van arra, hogy a törlést mindenféle ellenőrzés nélkül hajtsuk végre. Ez azt eredményezi, hogy a művelet jóval gyorsabb, azonban elővigyázatosnak kell lennünk, hiszen ha olyan képet törlünk, ami valahol (pl. egy sablonban) még használatban van, akkor az később hibákhoz vezethet.
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE /hammy/json/template/v3/assets/{{asset.id}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"attributes": {}
},
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
List message types
Visszaadja a rendszerben elmentett dokumentum típusokat és a hozzájuk tartozó aktuális állapotokat, figyelmen kívül hagyva az ARCHIVED státuszú sablonokat.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| statusListFilter | String [ ] | Szűrési feltételek a sablonok státuszára. | |
| templateKindFilter | TemplateKind | [DEPRECATED] Szűrési feltétel, a templateKind használandó. |
|
| templateKind | TemplateKind [ ] | A keresett sablon típusok. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Ha a templateKindFilter meg van adva, akkor ez a feltétel bekerül a templateKind értékei mellé.
Válasz
| Név | Típus | Leírás |
|---|---|---|
| layoutList | WLayout2 [ ] | A sablon kereteket tartalmazó lista. |
| messageTypeList | WMessageType3 [ ] | A üzenettípusokat tartalmazó lista. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v3:listMessageTypes>
<request>
<clientHashKey>?</clientHashKey>
<statusListFilter>
<!--Több státusz is lehet-->
<status>?</status>
</statusListFilter>
<templateKindFilter>?</templateKindFilter>
<templateKind>
<templateKind>?</templateKind>
</templateKind>
</request>
</v3:listMessageTypes>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:listMessageTypesResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<layoutList>
<layout>
<createdAt>2020-03-25T12:54:26.184+01:00</createdAt>
<description>nincs layout</description>
<htmlContent>${content}</htmlContent>
<name>nill_layout</name>
<uuid>1</uuid>
</layout>
<layout>
<createdAt>2013-12-09T15:28:32+01:00</createdAt>
<description>üres layoutxxxx</description>
<htmlContent><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title></title> </head> <body> Helló hali <div>${content}</div> </body></html>]]></htmlContent>
<name>empty_layout</name>
<uuid>fb680738-459f-11e9-b210-d663bd873d93</uuid>
</layout>
</layoutList>
<messageTypeList>
<messageType>
<createdAt>2017-08-07T09:00:19+02:00</createdAt>
<description>LA6145_generali-vagyon-karbejelento</description>
<layoutUuid>1</layoutUuid>
<messageTypeCode>generali-vagyon-karbejelento</messageTypeCode>
<status>DISABLED</status>
<templateHandlingCategory>1</templateHandlingCategory>
<templateHandlingCategoryUuid>1</templateHandlingCategoryUuid>
<templateHandlingCategoryName>Default Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<updatedAt>2017-11-07T13:21:19.003+01:00</updatedAt>
</messageType>
<messageType>
<createdAt>2017-08-07T09:00:19+02:00</createdAt>
<description>LA6145_generali-vagyon-karbejelento2</description>
<layoutUuid>1</layoutUuid>
<messageTypeCode>generali-vagyon-karbejelento2</messageTypeCode>
<status>DISABLED</status>
<templateHandlingCategory>1</templateHandlingCategory>
<templateHandlingCategoryUuid>1</templateHandlingCategoryUuid>
<templateHandlingCategoryName>Default Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<updatedAt>2017-11-07T14:58:45.188+01:00</updatedAt>
</messageType>
</messageTypeList>
</response>
</ns3:listMessageTypesResponse>
</S:Body>
</S:Envelope>
REST API
Layout
A REST API szolgáltatás eredménye nem tartalmaz sablon keret információt. Ehhez a List layouts szolgáltatás használandó.
Kérés
GET hammy/json/template/v4/messageTypes
| Paraméter | Típus | Leírás |
|---|---|---|
| typeOrDescription | String | A keresett típusnév vagy leírás. |
| messageTypeCategories | String [ ] | A keresett sablontípus kategóriák. |
| createdAtFrom | Date | A keresett sablon típusok. |
| createdAtTo | Date | Keresési feltétel a státuszokra. |
| limit | Integer | A keresési találatok maximális száma. |
| offset | Integer | A találati lista kezdete. |
| sort | String | Rendezés. |
| clientHashKey | String | A hívó kliens azonosítója. |
| userName | String | A felhasználó neve. |
| params | Param_V1 [ ] | Egyéb meta adatok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JMessageType2 [ ] | A megtalált sablonok. |
Minta
GET /hammy/json/template/v4/messageTypes?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "messageTypes",
"id": "TESZT_GEN",
"attributes": {
"description": "Teszt template generáláshoz",
"status": "DISABLED",
"createdAt": "2018-07-12T07:04:21.952+0000",
"updatedAt": "2018-07-12T07:04:21.952+0000",
"templateHandlingCategory": 5,
"templateHandlingCategoryName": "Default",
"templateKind": "normal",
"permissionShowList": [],
"permissionListList": []
}
},
...
],
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Create message type
Létrehoz egy új üzenettípust. Amennyiben a megadott név már létezik, akkor a metódus hibát fog jelezni. Az új típus minden esetben DISABLED státusszal jön létre. A layoutId megadása nem kötelező, ha nincs kitöltve, akkor az alapértelmezett kerettel fog létrejönni a típus.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageType | WMessageType3 | A létrehozandó üzenettípus. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| layout | WLayout2 | Az új üzenet sablon kerete. |
| messageType | WMessageType3 | Az új üzenettípus. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://hammy.dbx.hu/api/template/v4">
<soapenv:Header/>
<soapenv:Body>
<v4:createMessageType>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<params>
<param>
<key>alma</key>
<value>korte</value>
<ref>barack</ref>
</param>
</params>
<userName>pg</userName>
<messageType>
<canShow>true</canShow>
<description>WS 3 teszt</description>
<layoutUuid>UUID55</layoutUuid>
<messageTypeCode>WS_TESZT_MT_3</messageTypeCode>
<permissionListList>
<adGroup>admin</adGroup>
</permissionListList>
<permissionShowList>
<adGroup>admin</adGroup>
</permissionShowList>
<templateHandlingCategory>1</templateHandlingCategory>
<templateHandlingCategoryName>Def</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<templateSubkind>fragmented</templateSubkind>
</messageType>
</request>
</v4:createMessageType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://hammy.dbx.hu/model/template/v2" xmlns:ns3="http://hammy.dbx.hu/api/template/v4" xmlns:ns4="http://template.api.hammy.dbx.hu/">
<ns3:createMessageTypeResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<layout>
<createdAt>2018-03-09T12:09:45.592+01:00</createdAt>
<description>DDD</description>
<htmlContent>DDD</htmlContent>
<name>DDD</name>
<uuid>UUID55</uuid>
</layout>
<messageType>
<description>WS 3 teszt</description>
<layoutUuid>UUID55</layoutUuid>
<messageTypeCode>WS_TESZT_MT_3</messageTypeCode>
<status>DISABLED</status>
<templateHandlingCategory>1</templateHandlingCategory>
<templateHandlingCategoryName>Default Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<templateSubkind>fragmented</templateSubkind>
</messageType>
</response>
</ns3:createMessageTypeResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/template/v4/messageTypes
body: JMessageType3
Válasz
| Típus | Leírás |
|---|---|
| JMessageType3 | A létrehozott típus. |
Minta
POST /hammy/json/template/v4/messageTypes?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"id" : "JSON_API_MT_3",
"type" : "messageTypes",
"attributes" : {
"description" : "Fragmented Stencil Template",
"layoutUuid" : "UUID55",
"templateHandlingCategory" : 5,
"templateHandlingCategoryName" : "Default",
"templateKind" : "GENERATE",
"templateSubkind" : "FRAGMENTED",
"permissionShowList" : [],
"permissionListList" : [],
"canShow" : true
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "messageTypes",
"id": "JSON_API_MT_3",
"attributes": {
"description": "Fragmented Stencil Template",
"status": "DISABLED",
"layoutUuid": "UUID55",
"templateHandlingCategory": 1,
"templateHandlingCategoryName": "Default Error Category",
"templateKind": "generate",
"templateSubkind": "FRAGMENTED",
"permissionShowList": [],
"permissionListList": []
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Update message type
Módosítja a korábban létrehozott üzenettípust.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageType | WMessageType3 | A módosított üzenettípus. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| layout | WLayout2 | Az módosított üzenet sablon kerete. |
| messageType | WMessageType3 | A módosított üzenettípus. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<tem:updateMessageType>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageType>
<description>GB370 Senior casco törlésértesítő</description>
<messageTypeCode>370.CT</messageTypeCode>
<status>ENABLED</status>
<templateKind>normal</templateKind>
</messageType>
</request>
</tem:updateMessageType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createMessageTypeResponse xmlns:ns2="http://v4.ws.service.template.api.hammy.dbx.hu/">
<response>
<messageType>
<messageTypeCode>370.CT</messageTypeCode>
<description>GB370 Senior casco törlésértesítő</description>
<status>ENABLED</status>
<createdAt>2018-01-11T16:37:18.931Z</createdAt>
<updatedAt>2018-01-11T16:37:18.931Z</updatedAt>
<layoutId>1</layoutId>
</messageType>
<layout>
<id>1</id>
<name>base_layout</name>
<description>Alap layout, alkalmas minden levéltípushoz</description>
<createdAt>2018-01-11T16:37:18.931Z</createdAt>
<htmlContent><![CDATA[
<h1>XXX Biztostito</h1>
<p>#DATA</p>
]]>
</htmlContent>
</layout>
<status>
<code>0</code>
<messages/>
</status>
<params>
<param>
<key>?</key>
<value>?</value>
<ref>?</ref>
</param>
</params>
</response>
</ns2:createMessageTypeResponse>
</S:Body>
</S:Envelope>
REST API
Módosítások
Bár a JSON API miatt teljes messageTypes objektum kerül beküldésre, de csak néhány mező módosítható, a többi mező módosítását figyelmen kívül hagyja.
Kérés
PUT hammy/json/template/v4/messageTypes/{{messageTypeCode}}
PUT hammy/json/template/v4/messageTypes
body: JMessageType3
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A módosítandó üzenettípus kódja. |
Válasz
| Típus | Leírás |
|---|---|
| JMessageType3 | A módosított típus. |
Minta
PUT /hammy/json/template/v4/messageTypes?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"id" : "TESZT_GEN",
"type" : "messageTypes",
"attributes" : {
"description" : "Teszt template generáláshoz - módosítva",
"layoutId" : null,
"templateHandlingCategory" :5,
"templateKind" : "GENERATE",
"permissionShowList" : ["alma", "korte"],
"permissionListList" : ["kalapacs", "fogo"],
"canShow" : false
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "messageTypes",
"id": "TESZT_GEN",
"attributes": {
"description": "Teszt template generáláshoz - módosítva",
"status": "DISABLED",
"createdAt": "2018-07-12T07:14:03.790+0000",
"updatedAt": "2018-07-12T07:15:34.345+0000",
"templateHandlingCategory": 5,
"templateHandlingCategoryName": "Default",
"templateKind": "normal",
"permissionShowList": [],
"permissionListList": []
}
},
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete message type
Ebben a verzióban nem változott.
Show message type
Egy adott üzenettípus adatainak lekérdezése.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | Az üzenettípus kódja. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| layout | WLayout2 | A típushoz tartozó sablon keret. |
| messageType | WMessageType3 [ ] | A keresett üzenettípus. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:showMessageType>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageTypeCode>TEST.MAIL</messageTypeCode>
</request>
</v4:showMessageType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:showMessageTypeResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<messageType>
<createdAt>2019-01-22T16:47:41+01:00</createdAt>
<description>Teszt mail</description>
<messageTypeCode>TEST.MAIL</messageTypeCode>
<status>ENABLED</status>
<templateHandlingCategory>3</templateHandlingCategory>
<templateHandlingCategoryUuid>3</templateHandlingCategoryUuid>
<templateHandlingCategoryName>Strict Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<updatedAt>2019-01-22T16:47:41+01:00</updatedAt>
</messageType>
</response>
</ns3:showMessageTypeResponse>
</S:Body>
</S:Envelope>
REST API
Layout
A REST API szolgáltatás eredménye nem tartalmaz keret információt. Ehhez a List layouts szolgáltatás használandó.
Kérés
GET hammy/json/template/v4/messageTypes/{{messageTypeCode}}
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett üzenettípus azonosítója. |
Válasz
| Típus | Leírás |
|---|---|
| JMessageType3 | A megtalált típus. |
Minta
GET /hammy/json/template/v4/messageTypes/{{messageTypes.id}}?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "messageTypes",
"id": "TESZT_GEN",
"attributes": {
"description": "Teszt template generáláshoz - módosítva",
"status": "DISABLED",
"createdAt": "2018-07-12T07:14:03.790+0000",
"updatedAt": "2018-07-12T07:15:34.345+0000",
"templateHandlingCategory": 5,
"templateHandlingCategoryName": "Default",
"templateKind": "normal",
"permissionShowList": [],
"permissionListList": []
}
},
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Set message type status
Beállítja a megadott üzenettípus státuszát.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | Az üzenettípus azonosítója. | * |
| status | String | Az új státusz. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageType | WMessageType3 | A módosított üzenettípus. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:setMessageTypeStatus>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageTypeCode>generali-vagyon-karbejelento.copy.1</messageTypeCode>
<status>ENABLED</status>
</request>
</v4:setMessageTypeStatus>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:setMessageTypeStatusResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<messageType>
<createdAt>2019-06-06T13:16:10.678+02:00</createdAt>
<description>MASOLT</description>
<layoutUuid>1</layoutUuid>
<messageTypeCode>generali-vagyon-karbejelento.copy.1</messageTypeCode>
<status>ENABLED</status>
<templateHandlingCategory>1</templateHandlingCategory>
<templateHandlingCategoryUuid>1</templateHandlingCategoryUuid>
<templateHandlingCategoryName>Default Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<updatedAt>2020-07-14T12:54:34.704+02:00</updatedAt>
</messageType>
</response>
</ns3:setMessageTypeStatusResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/messageTypes/{{messageTypeCode}}/status/{{newStatus}}
A body üres.
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett üzenettípus azonosítója. (JSON API messageTypes ID-ja ) |
| newStatus | String | Az üzenettípus új státusza. |
Válasz
| Típus | Leírás |
|---|---|
| JMessageType3 | A módosított típus. |
Minta
PUT /hammy/json/template/v4/messageTypes/{{messageTypes.id}}/status/{{status}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "messageTypes",
"id": "{{messageTypes.id}}",
"attributes": {
"description": "Teszt template generáláshoz - módosítva",
"status": "{{status}}",
"createdAt": "2018-07-12T07:14:03.790+0000",
"updatedAt": "2018-07-12T08:59:04.612+0000",
"templateHandlingCategory": 5,
"templateHandlingCategoryName": "Default",
"templateKind": "normal",
"permissionShowList": [],
"permissionListList": []
}
},
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Set message types status
Több üzenettípus státuszának beállítása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCodeList | String | Az üzenettípusok azonosítói. | |
| status | String | Az új státusz. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageTypeList | WMessageType3 [ ] | A módosított üzenettípusok. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:setMessageTypesStatus>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageTypeCodeList>
<messageTypeCode>CAMPAIGN.KAMPANY-NEVE.7</messageTypeCode>
<messageTypeCode>CAMPAIGN.KAMPANY-NEVE.8</messageTypeCode>
</messageTypeCodeList>
<status>DISABLED</status>
</request>
</v4:setMessageTypesStatus>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:setMessageTypesStatusResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<messageTypeList>
<messageType>
<createdAt>2020-02-07T10:43:06.031+01:00</createdAt>
<description>kampany-leirasa</description>
<messageTypeCode>CAMPAIGN.KAMPANY-NEVE.7</messageTypeCode>
<status>DISABLED</status>
<templateHandlingCategory>4</templateHandlingCategory>
<templateHandlingCategoryName>EDM_CATEGORY</templateHandlingCategoryName>
<templateKind>campaign</templateKind>
<updatedAt>2020-07-14T14:32:08.592+02:00</updatedAt>
</messageType>
<messageType>
<createdAt>2020-02-07T10:54:07.966+01:00</createdAt>
<description>kampany-leirasa</description>
<messageTypeCode>CAMPAIGN.KAMPANY-NEVE.8</messageTypeCode>
<status>DISABLED</status>
<templateHandlingCategory>4</templateHandlingCategory>
<templateHandlingCategoryName>EDM_CATEGORY</templateHandlingCategoryName>
<templateKind>campaign</templateKind>
<updatedAt>2020-07-14T14:32:08.596+02:00</updatedAt>
</messageType>
</messageTypeList>
</response>
</ns3:setMessageTypesStatusResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/messageTypes/setMessageTypesStatus
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | JRequestMeta_V1 | A híváshoz tartozó metaadatok. |
| id | String | A kérés azonosítója. (vnd.api ID) |
| messageTypeCodeList | String [ ] | A módosítandó üzenettípusok kódjai. |
| status | String | Az új státusz. |
Válasz
| Típus | Leírás |
|---|---|
| JMessageType3 [ ] | A módosított üzenettípusok. |
Minta
PUT /hammy/json/template/v4/messageTypes/setMessageTypesStatus
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"id" : "1234",
"type" : "setMessageTypesStatusRequests",
"attributes" : {
"messageTypeCodeList" : ["351.DI", "351.EX"],
"status" : "ENABLED"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "messageTypes",
"attributes": {}
},
"meta": {
"total": null,
"responseStatus": {
"code": 0,
"messages": []
},
"params": []
}
}
Rename message type
Ebben a verzióban nem változott.
Copy message type
Ebben a verzióban nem változott.
List template versions
Visszaadja a megadott üzenet típushoz tartozó sablonverziókat.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | Az üzenettípus kódja. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateVersionList | WTemplateVersion4 [ ] | Sablon verziókat tartalmazó lista. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:listTemplateVersions>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageTypeCode>TEST.MAIL</messageTypeCode>
</request>
</v4:listTemplateVersions>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:listTemplateVersionsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersionList>
<templateVersion>
<uuid>1</uuid>
<versionNumber>1</versionNumber>
<actual>true</actual>
<htmlBody><![CDATA[<body>
Tisztelt ${userData.get("data/recipientName")}!<br/><br/>Szép napot! ${LINKA} <br/><br/>Üdvözlettel,<br/>Hammy
</body>]]></htmlBody>
<status>ACTUAL</status>
<subject>Main subject: ${mainMailSubject}</subject>
<variables>
<variable>
<uuid>2688c9e3-4da7-4fb7-8fda-a5a8ba69e952</uuid>
<key>testKey</key>
<label>Test label</label>
<valueType>text</valueType>
<values>test;values</values>
<constraints>test*constraints</constraints>
<category>test category</category>
<mandatory>false</mandatory>
</variable>
</variables>
</templateVersion>
</templateVersionList>
</response>
</ns3:listTemplateVersionsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett üzenettípus kódja. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTemplateVersion2 [ ] | A megtalált verziók. |
Minta
GET /hammy/json/template/v4/messageTypes/{{messageTypes.id}}/templateVersions?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "templateVersions",
"id": "{{uuid}}",
"attributes": {
"versionNumber": 1,
"status": "ACTUAL",
"subject": "Tárgy mező",
"actual": true,
"plainTextBody": "Törzs mező",
"createdAt": "2018-07-12T08:16:06.073+0000",
"updatedAt": "2018-07-12T08:16:06.091+0000",
"generationItemUUID": "5d04bf6b-68b4-4420-a167-3c68ad7a6a07",
"relations": [
{
"name": "header",
"description": "Header fragment",
"relatedMessageType": "HEADER"
},
{
"name": "footer"
}
]
}
}
],
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
{
"data": {
"type": "templateVersions",
"id": "fragment1",
"attributes": {
"versionNumber": 12,
"status": "ACTUAL",
"subject": "Fragment container",
"actual": true,
"plainTextBody": "Fragment container",
"createdAt": "2019-07-08T07:38:33.790+0000",
"updatedAt": "2019-07-08T07:38:35.791+0000",
"generationItemUUID": "5d04bf6b-68b4-4420-a167-3c68ad7a6a07",
"relations": [
{
"name": "header",
"description": "Header fragment",
"relatedMessageType": "HEADER"
},
{
"name": "footer"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Show template version
Adott sablon verzió megtekintése.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | A üzenettípus kódja. | * |
| versionNumber | Integer | A sablon verziószáma. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateVersion | WTemplateVersion4 | Az adott sablon verzió. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:showTemplateVersion>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<messageTypeCode>Pdf_gen_teszt</messageTypeCode>
<versionNumber>1</versionNumber>
</request>
</v4:showTemplateVersion>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:showTemplateVersionResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersion>
<uuid>9e34e01d-5dd3-4936-a0a8-3e272e722705</uuid>
<versionNumber>1</versionNumber>
<actual>true</actual>
<createdAt>2020-06-04T16:07:50.684+02:00</createdAt>
<fileName>Teszt_pdf_v1.docx</fileName>
<status>ACTUAL</status>
<subject>Pdf</subject>
<updatedAt>2020-06-04T16:19:42.184+02:00</updatedAt>
<generationItemUUID>1070965f-fa4f-466e-ad1a-9750f9691872</generationItemUUID>
<variables>
<variable>
<uuid>4b15f072-cf14-45b2-8223-6e8a53527dcf</uuid>
<key>policyNum</key>
<label>Szerződésszám</label>
<valueType>number</valueType>
<constraints>policyNum-numeric-only;policyNum-min-length</constraints>
<category>data</category>
<mandatory>true</mandatory>
</variable>
<variable>
<uuid>a1db7eb7-2002-4477-bc4d-2778d819ec82</uuid>
<key>Name</key>
<label>Customer Name update4</label>
<valueType>plain/text</valueType>
<values>test1;test2;test3;test4</values>
<constraints>name-valid-min-5-length</constraints>
<category>Personal Data</category>
<mandatory>true</mandatory>
</variable>
</variables>
<templateVersionMetadata>test meta data</templateVersionMetadata>
</templateVersion>
</response>
</ns3:showTemplateVersionResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett üzenettípus kódja. |
| versionNumber | Integer | Az adott verzió száma. |
Válasz
| Típus | Leírás |
|---|---|
| JTemplateVersion4 | A keresett verzió. |
Minta
GET /hammy/json/template/v4/messageTypes/{{messageType.id}}/templateVersions/{{versionNumber}}?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateVersions",
"id": "{{uuid}}",
"attributes": {
"versionNumber": {{versionNumber}},
"status": "OLD",
"subject": "Tárgy mező",
"actual": false,
"plainTextBody": "Törzs erdő",
"createdAt": "2018-07-02T09:04:31.024+0000",
"updatedAt": "2018-07-02T09:21:05.681+0000"
}
},
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Show template version content
Ebben a verzióban nem változott.
Show template version content V3
Create or update template version
A metódus új template verzió létrehozására, vagy DRAFT állapotú sablon verzió módosítására szolgál. Új verzió létrehozásakor a versionNumber növekszik eggyel az eddigi éles (ACTUAL) template verzióhoz képest.
A bemenő TemplateVersion objektumban a versionNumber és a status paramétert nem szabad kitölteni, viszont a válaszban már ki lesznek töltve ezek a mezők.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | A dokumentum típus kódja. | * |
| templateVersion | WTemplateVersion2 | A sablon verzió új adatai. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateVersion | WTemplateVersion4 | A módosított sablon verzió. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header />
<soapenv:Body>
<v4:createOrUpdateTemplateVersion>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<params>
<param>
<key>alma</key>
<value>korte</value>
<ref>barack</ref>
</param>
</params>
<userName>pg</userName>
<messageTypeCode>WS_TESZT_MT_3</messageTypeCode>
<templateVersion>
<actual>true</actual>
<description>alma description</description>
<htmlBody><![CDATA[<html><body>alma</body></html>]]></htmlBody>
<noticeTemplateVersionNum>?</noticeTemplateVersionNum>
<status>ACTUAL</status>
<subject>Alma</subject>
<relations>
<name>header</name>
<description>Fejléc</description>
<relatedMessageType>HEADER</relatedMessageType>
<relatedTemplateVersion>1</relatedTemplateVersion>
</relations>
<relations>
<name>footer</name>
<description>Lábléc (még nincs megadva)</description>
</relations>
</templateVersion>
</request>
</v4:createOrUpdateTemplateVersion>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://hammy.dbx.hu/model/template/v2" xmlns:ns3="http://hammy.dbx.hu/api/template/v3" xmlns:ns4="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:createOrUpdateTemplateVersionResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersion>
<uuid>0167772f-487c-463e-9829-5fbe492e2391</uuid>
<versionNumber>1</versionNumber>
<actual>true</actual>
<createdAt>2019-07-10T11:41:54.309+02:00</createdAt>
<description>alma description</description>
<htmlBody><html><body>alma</body></html></htmlBody>
<status>ACTUAL</status>
<subject>Alma</subject>
<relations>
<name>header</name>
<description>Fejléc</description>
<relatedMessageType>HEADER</relatedMessageType>
<relatedTemplateVersion>1</relatedTemplateVersion>
</relations>
<relations>
<name>footer</name>
<description>Lábléc (még nincs megadva)</description>
</relations>
</templateVersion>
</response>
</ns3:createOrUpdateTemplateVersionResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
CREATE
POST hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions
A kérés lehet:
multipart/form-data. Aztemplate_versionnevű részben a sablon json leíróját (JTemplateVersion4), aztemplate_version_bodyrészben pedig a sablon tartalmát binárisan kell küldeni.application/json. Ha nincs a sablonhoz tartalom, akkor nem kell multipart.
Öröklés
Ha nincs tartalom a kérésben, akkor az előző sablon verzió fájlját örököli, hacsak az öröklés explicit nincs megtiltva. A tiltást a CONTENT_INHERITANCE kérési paraméter N értékének beküldésével lehet elérni.
UPDATE
PUT hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett üzenettípus kódja. |
A kérés lehet:
multipart/form-data. Aztemplate_versionnevű részben a sablon json leíróját (JTemplateVersion4), aztemplate_version_bodyrészben pedig a sablon tartalmát binárisan kell küldeni.application/json. Ha nincs a sablonhoz tartalom, akkor nem kell multipart.
Válasz
| Típus | Leírás |
|---|---|
| JTemplateVersion4 | Az új verzió. |
Minta
POST/PUT /hammy/json/template/v4/messageTypes/{{messageTypes.id}}/templateVersions?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
content-type: multipart/form-data; boundary=-----------------------------{{boundary}}
-----------------------------{{boundary}}
Content-Disposition: form-data; name="template_version"
Content-Type: application/json
{
"data": {
"id" : "{{uuid}}",
"type": "templateVersions",
"attributes": {
"status": "ACTUAL",
"subject": "Tárgy mező",
"actual": true,
"plainTextBody": "Törzs mező"
}
}
}
-----------------------------{{boundary}}
Content-Disposition: form-data; name="template_version_body"
Content-Type: application/octet-stream
[BINÁRIS TARTALOM]
-----------------------------{{boundary}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Authorization: JWT {{jwtToken}}
Transfer-Encoding: chunked
{
"data" : {
"type" : "templateVersions",
"id" : "{{uuid}}",
"attributes" : {
"versionNumber" : 1,
"status" : "ACTUAL",
"subject" : "Tárgy mező",
"actual" : true,
"plainTextBody" : "Törzs mező",
"createdAt" : "2018-07-12T08:16:06.073+0000"
}
},
"meta" : {
"total" : null,
"params" : [ ],
"responseStatus" : {
"code" : 0,
"messages" : [ ]
}
}
}
Delete template version
Törli a megadott sablon verziót.
Nem létező UUID esetén validációs hiba keletkezik. Olyan sablon verziónál amit már használtak kiküldésre, szintén validációs hiba keletkezik.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| uuid | String | A törlendő verzió UUID-ja. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:deleteTemplateVersion>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<uuid>{{templateVersionUuid}}</uuid>
</request>
</v4:deleteTemplateVersion>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns2:deleteTemplateVersionResponse xmlns:ns2="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns3="http://v3.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:deleteTemplateVersionResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/template/v4/templateVersions/{{uuid}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A törlendő verzió UUID-ja. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE /hammy/json/template/v4/messageTypes/templateVersions/{{teplateVersion.uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "7898b16e-9b00-4d06-99f3-3ad97c0050fb",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
List template version links
Adott sablon verzió linkjeinek listázása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | A sablon típus kódja. | |
| versionNumber | Integer | A az adott verzió száma. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateVersionLinks | WTemplateVersionLink1 [ ] | A kért sablon verzióhoz tartozó linkek. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:listTemplateVersionLinks>
<!--Optional:-->
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<!--Optional:-->
<userName>admin</userName>
<!--Optional:-->
<messageTypeCode>link_teszt</messageTypeCode>
<!--Optional:-->
<versionNumber>2</versionNumber>
</request>
</v4:listTemplateVersionLinks>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns3:listTemplateVersionLinksResponse xmlns:ns2="http://template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v3.template.api.hammy.dbx.hu/" xmlns:ns5="http://v2.template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersionLinks>
<uuid>ffdaa85a-a231-4c57-bc9a-8021f37befa2</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>b4bc85d6-5cb2-4f90-8f3f-0b1cd73ba8cf</uuid>
<title>Dbx</title>
<realLink>https://dbx.hu</realLink>
</mailLink>
<linkText>link</linkText>
</templateVersionLinks>
<templateVersionLinks>
<uuid>9c2f53a7-3dd9-4085-abdb-542b02e19ba5</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>29b37467-d157-4c80-8770-c058c86648e0</uuid>
<title>Twitter</title>
<realLink>https://twitter.com</realLink>
</mailLink>
<linkText>link</linkText>
</templateVersionLinks>
<templateVersionLinks>
<uuid>872492ec-6b08-40fe-a1a0-ffe722e22970</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>c06b7693-f211-473f-9ac5-2067eb2ed58a</uuid>
<title>Van-e net?</title>
<realLink>https://vanenet.hu</realLink>
</mailLink>
<linkText>ez</linkText>
<expirationDate>$lejaratinap</expirationDate>
<alterLink>https://valamimas.hu</alterLink>
</templateVersionLinks>
<templateVersionLinks>
<uuid>c835ed64-a99d-48b7-940f-3ac183a6099d</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>43963786-d606-40c8-98fb-f744bfb689e3</uuid>
<title>Google</title>
<realLink>https://google.hu</realLink>
</mailLink>
<linkText>Itt</linkText>
<expirationDate>$lejaratinap</expirationDate>
<alterLink>https://tesztvalami.hu</alterLink>
</templateVersionLinks>
</response>
</ns3:listTemplateVersionLinksResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}/templateVersionLinks
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A sablon típus kódja. |
| versionNumber | Integer | A verzió száma. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTemplateVersionMailLink1 [ ] | A megtalált linkek. |
Minta
GET /hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}/templateVersionLinks
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "templateVersionMailLinks",
"id": "ffdaa85a-a231-4c57-bc9a-8021f37befa2",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "link"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "b4bc85d6-5cb2-4f90-8f3f-0b1cd73ba8cf"
}
}
}
},
{
"type": "templateVersionMailLinks",
"id": "c835ed64-a99d-48b7-940f-3ac183a6099d",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "Itt",
"expirationDate": "$lejaratinap",
"alterLink": "https://tesztvalami.hu"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3"
}
}
}
},
{
"type": "templateVersionMailLinks",
"id": "9c2f53a7-3dd9-4085-abdb-542b02e19ba5",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "link"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "29b37467-d157-4c80-8770-c058c86648e0"
}
}
}
},
{
"type": "templateVersionMailLinks",
"id": "872492ec-6b08-40fe-a1a0-ffe722e22970",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "ez",
"expirationDate": "$lejaratinap",
"alterLink": "https://valamimas.hu"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "c06b7693-f211-473f-9ac5-2067eb2ed58a"
}
}
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
},
"included": [
{
"type": "mailLinks",
"id": "b4bc85d6-5cb2-4f90-8f3f-0b1cd73ba8cf",
"attributes": {
"title": "Dbx",
"realLink": "https://dbx.hu"
}
},
{
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3",
"attributes": {
"title": "Google",
"realLink": "https://google.hu"
}
},
{
"type": "mailLinks",
"id": "29b37467-d157-4c80-8770-c058c86648e0",
"attributes": {
"title": "Twitter",
"realLink": "https://twitter.com"
}
},
{
"type": "mailLinks",
"id": "c06b7693-f211-473f-9ac5-2067eb2ed58a",
"attributes": {
"title": "Van-e net?",
"realLink": "https://vanenet.hu"
}
}
]
}
Show template version link
Adott sablon verzió linkjének megtekintése.
Web service API
Kérés
| Mező | Típus | Leírás | Kötelező |
|---|---|---|---|
| versionLinkUuid | String | A sablon verzió link UUID-je. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Mező | Típus | Leírás |
|---|---|---|
| templateVersionLink | WTemplateVersionLink1 | A keresett link. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:showTemplateVersionLink>
<!--Optional:-->
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<!--Optional:-->
<userName>admin</userName>
<!--Optional:-->
<versionLinkUuid>872492ec-6b08-40fe-a1a0-ffe722e22970</versionLinkUuid>
</request>
</v4:showTemplateVersionLink>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns3:showTemplateVersionLinkResponse xmlns:ns2="http://template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v3.template.api.hammy.dbx.hu/" xmlns:ns5="http://v2.template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersionLink>
<uuid>872492ec-6b08-40fe-a1a0-ffe722e22970</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>c06b7693-f211-473f-9ac5-2067eb2ed58a</uuid>
<title>Van-e net?</title>
<realLink>https://vanenet.hu</realLink>
</mailLink>
<linkText>ez</linkText>
<expirationDate>$lejaratinap</expirationDate>
<alterLink>https://valamimas.hu</alterLink>
</templateVersionLink>
</response>
</ns3:showTemplateVersionLinkResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/templateVersionLinks/{{versionLinkUuid}}
| Név | Típus | Leírás |
|---|---|---|
| versionLinkUuid | String | A keresett link UUID-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JTemplateVersionMailLink1 | A keresett link. |
Minta
GET /hammy/json/template/v4/templateVersionLinks/{{templateVersionLinkUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateVersionMailLinks",
"id": "c835ed64-a99d-48b7-940f-3ac183a6099d",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "Itt",
"expirationDate": "$lejaratinap",
"alterLink": "https://tesztvalami.hu"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3"
}
}
}
},
"included": [
{
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3",
"attributes": {
"title": "Google",
"realLink": "https://google.hu"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Update template version link
Adott sablon verzió linkjének módosítása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| messageTypeCode | String | A sablon típus kódja. | |
| versionNumber | Integer | A verzió száma. | |
| templateVersionLink | WTemplateVersionLink1 | A változtatandó link. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateVersionLink | WTemplateVersionLink1 | A módosított link. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:updateTemplateVersionMailLink>
<!--Optional:-->
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<!--Optional:-->
<userName>admin</userName>
<!--Optional:-->
<messageTypeCode>link_teszt</messageTypeCode>
<!--Optional:-->
<versionNumber>3</versionNumber>
<!--Optional:-->
<templateVersionLink>
<uuid>872492ec-6b08-40fe-a1a0-ffe722e22970</uuid>
<expirationDate>$lejaratinap</expirationDate>
<alterLink>https://valamimas.hu</alterLink>
</templateVersionLink>
</request>
</v4:updateTemplateVersionMailLink>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns3:updateTemplateVersionMailLinkResponse xmlns:ns2="http://template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v3.template.api.hammy.dbx.hu/" xmlns:ns5="http://v2.template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateVersionLink>
<uuid>872492ec-6b08-40fe-a1a0-ffe722e22970</uuid>
<templateVersionUuid>9b3e9e47-fb8f-43a4-9fbb-6990943bccd8</templateVersionUuid>
<mailLink>
<uuid>c06b7693-f211-473f-9ac5-2067eb2ed58a</uuid>
<title>Van-e net?</title>
<realLink>https://vanenet.hu</realLink>
</mailLink>
<linkText>ez</linkText>
<expirationDate>$lejaratinap</expirationDate>
<alterLink>https://valamimas.hu</alterLink>
</templateVersionLink>
</response>
</ns3:updateTemplateVersionMailLinkResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}/templateVersionLinks
| Név | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A módosítandó üzenettípus kódja. |
| versionNumber | Integer | Az adott verzió száma. |
Válasz
| Típus | Leírás |
|---|---|
| JTemplateVersionMailLink1 | A módosított link. |
Minta
PUT /hammy/json/template/v4/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}/templateVersionLinks
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateVersionMailLinks",
"id": "c835ed64-a99d-48b7-940f-3ac183a6099d",
"attributes": {
"expirationDate": "$lejaratinap",
"alterLink": "https://tesztvalami.hu"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateVersionMailLinks",
"id": "c835ed64-a99d-48b7-940f-3ac183a6099d",
"attributes": {
"templateVersionUuid": "9b3e9e47-fb8f-43a4-9fbb-6990943bccd8",
"linkText": "Itt",
"expirationDate": "$lejaratinap",
"alterLink": "https://tesztvalami.hu"
},
"relationships": {
"mailLink": {
"data": {
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3"
}
}
}
},
"included": [
{
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3",
"attributes": {
"title": "Google",
"realLink": "https://google.hu"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
List layouts
Ebben a verzióban nem változott.
Create layout
Ebben a verzióban nem változott.
Update layout
Ebben a verzióban nem változott.
Delete layout
Ebben a verzióban nem változott.
List template handling categories
Visszaadja a rendszerben mentett, a sablon kategóriák listáját.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| categoryName | String | A keresett kategória neve. | |
| limit | Integer | A keresési találatok maximális száma. | |
| offset | Integer | A találati lista kezdete. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateHandlingCategoryList | WTemplateHandlingCategory2 [ ] | Sablon kategóriák listája. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:listTemplateHandlingCategories>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
</request>
</v4:listTemplateHandlingCategories>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:listTemplateHandlingCategoriesResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateHandlingCategoryList>
<templateHandlingCategory>
<uuid>3</uuid>
<categoryName>Strict Error Category</categoryName>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
<templateHandlingCategory>
<uuid>f49dfd76-1a66-4cdd-be39-bd8dab1f07bc</uuid>
<categoryName>Statistics Category</categoryName>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
<templateHandlingCategory>
<categoryName>EDM_CATEGORY</categoryName>
<assetDeliveryMode>inline</assetDeliveryMode>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>true</replaceLinks>
</templateHandlingCategory>
</templateHandlingCategoryList>
</response>
</ns3:listTemplateHandlingCategoriesResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/templateHandlingCategories
| Paraméter | Típus | Leírás |
|---|---|---|
| categoryName | String | A keresett kategória neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTemplateHandlingCategory1 [ ] | A megtalált verziók. |
Minta
GET /hammy/json/template/v4/templateHandlingCategories?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "templateHandlingCategories",
"id": "5",
"attributes": {
"categoryName": "Default",
"replaceLinks": false,
"assetDeliveryMode": "INLINE",
"renderMarkdown": false
},
"relationships": {
"erHandlingCategory": {
"data": {
"type": "errorHandlingCategories",
"id": "1"
}
}
}
}
],
"included": [
{
"type": "errorHandlingCategories",
"id": "1",
"attributes": {
"name": "Normal",
"failureLimitPerMin": 10,
"responsibles": "hammy@dbx.hu",
"punishmentMins": 60
}
}
],
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Create template handling category
Sablon kategória létrehozása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| templateHandlingCategory | WTemplateHandlingCategory2 | A létrehozandó kategória. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateHandlingCategory | WTemplateHandlingCategory2 | A létrehozott kategória. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:createTemplateHandlingCategory>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<userName>admin</userName>
<templateHandlingCategory>
<categoryName>TESZT_CAT</categoryName>
<erHandlingCategory>
<name>normal</name>
</erHandlingCategory>
</templateHandlingCategory>
</request>
</v4:createTemplateHandlingCategory>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns2:createTemplateHandlingCategoryResponse xmlns:ns2="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns3="http://v3.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateHandlingCategory>
<uuid>cf0231c0-e9f2-4c62-bf5b-6075db039307</uuid>
<categoryName>TESZT_CAT</categoryName>
<erHandlingCategory>
<failureLimitPerMin>30</failureLimitPerMin>
<id>1</id>
<name>normal</name>
<punishmentMins>60</punishmentMins>
<responsibles>peter.fulop@dbx.hu</responsibles>
</erHandlingCategory>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
</response>
</ns2:createTemplateHandlingCategoryResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/template/v4/templateHandlingCategories
Válasz
| Típus | Leírás |
|---|---|
| JTemplateHandlingCategory1 | A létrehozott kategória. |
Minta
POST /hammy/json/template/v4/templateHandlingCategories
PUT /hammy/json/template/v4/templateHandlingCategories/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateHandlingCategories",
"attributes": {
"categoryName": "teszt_valami_123"
},
"relationships": {
"erHandlingCategory": {
"data": {
"type": "erHandlingCategories",
"id": "1"
}
}
}
},
"included": [
{
"type": "erHandlingCategories",
"id": "1",
"attributes": {
"name": "normal"
}
}
]
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateHandlingCategories",
"id": "5626171f-7819-4fad-9e16-d224e617d02b",
"attributes": {
"categoryName": "teszt_valami_123",
"replaceLinks": false,
"renderMarkdown": false
},
"relationships": {
"erHandlingCategory": {
"data": {
"type": "erHandlingCategories",
"id": "1"
}
}
}
},
"included": [
{
"type": "erHandlingCategories",
"id": "1",
"attributes": {
"name": "normal",
"failureLimitPerMin": 30,
"responsibles": "peter.fulop@dbx.hu",
"punishmentMins": 60
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Update template handling category
Sablon kategória módosítása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| templateHandlingCategory | WTemplateHandlingCategory2 | A módosítandó kategória. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| templateHandlingCategory | WTemplateHandlingCategory2 | A módosított kategória. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:updateTemplateHandlingCategory>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<userName>admin</userName>
<templateHandlingCategory>
<uuid>e58d6b9d-8a0b-46fb-a2bd-746498b89255</uuid>
<categoryName>TESZT_CATEGORY_UJ</categoryName>
</templateHandlingCategory>
</request>
</v4:updateTemplateHandlingCategory>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns2:updateTemplateHandlingCategoryResponse xmlns:ns2="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns3="http://v3.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<templateHandlingCategory>
<uuid>e58d6b9d-8a0b-46fb-a2bd-746498b89255</uuid>
<categoryName>TESZT_CATEGORY_UJ</categoryName>
<erHandlingCategory>
<failureLimitPerMin>30</failureLimitPerMin>
<id>1</id>
<name>normal</name>
<punishmentMins>60</punishmentMins>
<responsibles>peter.fulop@dbx.hu</responsibles>
</erHandlingCategory>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
</response>
</ns2:updateTemplateHandlingCategoryResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/templateHandlingCategories/{{uuid}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A módosítandó kategória UUID-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JTemplateHandlingCategory1 | A létrehozott kategória. |
Minta
POST /hammy/json/template/v4/templateHandlingCategories
PUT /hammy/json/template/v4/templateHandlingCategories/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateHandlingCategories",
"attributes": {
"categoryName": "teszt_valami_123"
},
"relationships": {
"erHandlingCategory": {
"data": {
"type": "erHandlingCategories",
"id": "1"
}
}
}
},
"included": [
{
"type": "erHandlingCategories",
"id": "1",
"attributes": {
"name": "normal"
}
}
]
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "templateHandlingCategories",
"id": "5626171f-7819-4fad-9e16-d224e617d02b",
"attributes": {
"categoryName": "teszt_valami_123",
"replaceLinks": false,
"renderMarkdown": false
},
"relationships": {
"erHandlingCategory": {
"data": {
"type": "erHandlingCategories",
"id": "1"
}
}
}
},
"included": [
{
"type": "erHandlingCategories",
"id": "1",
"attributes": {
"name": "normal",
"failureLimitPerMin": 30,
"responsibles": "peter.fulop@dbx.hu",
"punishmentMins": 60
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete template handling category
Töröl egy sablon kategóriát.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| uuid | String | A törlendő kategória UUID-ja. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:deleteTemplateHandlingCategory>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<userName>admin</userName>
<uuid>cf0231c0-e9f2-4c62-bf5b-6075db039307</uuid>
</request>
</v4:deleteTemplateHandlingCategory>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns2:deleteTemplateHandlingCategoryResponse xmlns:ns2="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns3="http://v3.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:deleteTemplateHandlingCategoryResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/template/v4/templateHandlingCategories/{{uuid}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A törlendő kategória UUID-ja. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
DELETE /hammy/json/template/v4/templateHandlingCategories/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "4d263a00-f2d2-46f5-9fb2-69bf6bc8be3c",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Export templates
Sablonok exportálása a rendszerből.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| inline | Boolean | ||
| templateNameList | String [ ] | Exportálandó sablonok nevei. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| exportMessageList | WExportMessage4 [ ] | Exportált sablonok. |
| filePath | String | Jelenleg nincs használva. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:exportTemplates>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<templateNameList>
<templateName>TEST.MAIL</templateName>
</templateNameList>
</request>
</v4:exportTemplates>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:exportTemplatesResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<exportMessageList>
<exportMessage>
<assetList/>
<cgParamList>
<cgParam>
<id>65</id>
<key>fix_attachment</key>
<value>fix.txt</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>2210</id>
<key>zip_attachments_file_name</key>
<value>attachments.zip</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>66</id>
<key>email_file_name</key>
<value>fix_new.txt</value>
<objectType>cg_param</objectType>
<objectId>65</objectId>
</cgParam>
<cgParam>
<id>4147</id>
<key>zip_attachments</key>
<value>NO</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>1731</id>
<key>email_file_name</key>
<value>fix_new2.txt</value>
<objectType>cg_param</objectType>
<objectId>66</objectId>
</cgParam>
<cgParam>
<id>1928</id>
<key>object_ref_source</key>
<value>test_object_ref</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>66104</id>
<key>ATTACHMENT_CACHE_ENABLED</key>
<value>YES</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>65419</id>
<key>default_channel</key>
<value>EMAIL</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>3691</id>
<key>velocity_template_validation</key>
<value>PRE</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
<cgParam>
<id>66108</id>
<key>ATTACHMENT_CACHE_TTL</key>
<value>5m</value>
<objectType>template</objectType>
<objectId>TEST.MAIL</objectId>
</cgParam>
</cgParamList>
<messageType>
<createdAt>2019-01-22T16:47:41+01:00</createdAt>
<description>Teszt mail</description>
<messageTypeCode>TEST.MAIL</messageTypeCode>
<status>ENABLED</status>
<templateHandlingCategory>3</templateHandlingCategory>
<templateHandlingCategoryUuid>3</templateHandlingCategoryUuid>
<templateHandlingCategoryName>Strict Error Category</templateHandlingCategoryName>
<templateKind>normal</templateKind>
<updatedAt>2019-01-22T16:47:41+01:00</updatedAt>
</messageType>
<templateHandlingCategory>
<uuid>3</uuid>
<categoryName>Strict Error Category</categoryName>
<erHandlingCategory>
<failureLimitPerMin>2</failureLimitPerMin>
<id>2</id>
<punishmentMins>1</punishmentMins>
<responsibles>csaba.harangozo@dbx.hu</responsibles>
</erHandlingCategory>
<renderMarkdown>false</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
<templateVersionList>
<templateVersion>
<uuid>1</uuid>
<versionNumber>1</versionNumber>
<actual>true</actual>
<htmlBody><![CDATA[<body>
Tisztelt ${userData.get("data/recipientName")}!<br/><br/>Szép napot! ${LINKA} <br/><br/>Üdvözlettel,<br/>Hammy
</body>]]></htmlBody>
<status>ACTUAL</status>
<subject>Main subject: ${mainMailSubject}</subject>
<variables>
<variable>
<uuid>2688c9e3-4da7-4fb7-8fda-a5a8ba69e952</uuid>
<key>testKey</key>
<label>Test label</label>
<valueType>text</valueType>
<values>test;values</values>
<constraints>test*constraints</constraints>
<category>test category</category>
<mandatory>false</mandatory>
</variable>
</variables>
</templateVersion>
</templateVersionList>
</exportMessage>
</exportMessageList>
</response>
</ns3:exportTemplatesResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/exportTemplates
- Új verzió, generált sablon esetén tömöríti az exportált állományt.
GET hammy/json/template/v4/exportTemplatesOld
- Régi verzió, nem tömörít.
| Paraméter | Típus | Leírás |
|---|---|---|
| templateNameList | String [ ] | Az exportálandó sablonok nevei. |
| inline | Boolean |
Válasz
application/octet-stream
| Név | Típus | Leírás |
|---|---|---|
| exportMessageList | WExportMessage4 [ ] | Exportált sablonok. |
| filePath | String | Jelenleg nincs használva. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
GET /hammy/json/template/v4/exportTemplates?templateNameList%5B%5D=TP
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: application/octet-stream
Content-Disposition: attachment; filename*=UTF-8''export.json
{
"exportMessageList" : [ {
"messageType" : {
"messageTypeCode" : "TP",
"description" : "TP",
"status" : "DISABLED",
"createdAt" : "2018-11-08T12:06:52.731+0000",
"updatedAt" : "2019-05-15T11:29:20.997+0000",
"layoutId" : "2222",
"templateHandlingCategory" : 156,
"templateHandlingCategoryName" : "TP",
"templateKind" : "TP",
"permissionShowList" : [ ],
"permissionListList" : [ ]
},
"templateHandlingCategory" : {
"uuid" : "2222",
"categoryName" : "TP",
"replaceLinks" : false,
"renderMarkdown" : true,
"erHandlingCategory" : {
"id" : 114,
"name" : "TP",
"failureLimitPerMin" : 10,
"responsibles" : "TP@dbx.hu",
"punishmentMins" : 10
}
},
"layout" : {
"uuid" : "2222",
"name" : "TP",
"description" : "TP",
"createdAt" : "2018-07-18T15:39:41.000+0000",
"htmlContent" : "<html><head><meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8\"/></head><body>${content}</body></html>"
},
"templateVersionList" : [ ],
"assetList" : [ ],
"cgParamList" : {
"cgParam" : [ {
"id" : 7254,
"key" : "LAYOUT",
"value" : "183",
"objectType" : "template",
"objectId" : "TP"
} ]
},
"customData" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<listTemplateParamResp>\r\n <categoryList/>\r\n <customXml></customXml>\r\n <documents>\r\n <document>\r\n <filename>${fileName}</filename>\r\n </document>\r\n </documents>\r\n <templateDynamicParamList/>\r\n <templateName>TP</templateName>\r\n</listTemplateParamResp>\r\n"
} ]
}
Import templates
Sablonok importálása a rendszerbe.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| exportMessageList | WExportMessage4 [ ] | Importálandó sablonok. | |
| filePath | String | Jelenleg nincs használva. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| params | Param_V1 [ ] | Egyéb paraméterek listája. | | status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:importTemplates>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<exportMessageList>
<exportMessage>
<assetList/>
<cgParamList/>
<customData>
<![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]>
</customData>
<layout>
<createdAt>2018-07-18T17:39:41+02:00</createdAt>
<description>TP</description>
<htmlContent><![CDATA[<html><head><meta http-equiv="Content-type" content="text/html; charset=utf-8"/></head><body>${content}</body></html>]]></htmlContent>
<id>183</id>
<name>TP</name>
</layout>
<messageType>
<createdAt>2018-11-08T13:06:52.731+01:00</createdAt>
<description>TP</description>
<layoutId>2222</layoutId>
<messageTypeCode>TP</messageTypeCode>
<permissionListList/>
<permissionShowList/>
<status>DISABLED</status>
<templateHandlingCategory>156</templateHandlingCategory>
<templateHandlingCategoryName>TP</templateHandlingCategoryName>
<templateKind>TP</templateKind>
<updatedAt>2019-05-15T13:29:20.997+02:00</updatedAt>
</messageType>
<templateHandlingCategory>
<categoryName>TP</categoryName>
<erHandlingCategory>
<failureLimitPerMin>10</failureLimitPerMin>
<id>114</id>
<name>TP</name>
<punishmentMins>10</punishmentMins>
<responsibles>TP@dbx.hu</responsibles>
</erHandlingCategory>
<id>156</id>
<renderMarkdown>true</renderMarkdown>
<replaceLinks>false</replaceLinks>
</templateHandlingCategory>
<templateVersionList/>
</exportMessage>
</exportMessageList>
<!--Optional:-->
<filePath>?</filePath>
</request>
</v4:importTemplates>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:importTemplatesResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns3:importTemplatesResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/importTemplates
- Új verzió, tömörített állományt is kezel.
PUT hammy/json/template/v4/importTemplatesOld
- Régi verzió, tömörített állományt nem kezel.
multipart kérés.
| Multipart név | Típus | Leírás |
|---|---|---|
| import_data | WExportMessage4 [ ] | Az importálandó sablonok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
PUT /hammy/json/template/v4/importTemplates
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: multipart/form-data
import_data={{path}}{{fileName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"exportMessageList" : [ {
"messageType" : {
"messageTypeCode" : "TP",
"description" : "TP",
"status" : "DISABLED",
"createdAt" : "2018-11-08T12:06:52.731+0000",
"updatedAt" : "2019-05-15T11:29:20.997+0000",
"layoutId" : "2222",
"templateHandlingCategory" : 156,
"templateHandlingCategoryName" : "TP",
"templateKind" : "TP",
"permissionShowList" : [ ],
"permissionListList" : [ ]
},
"templateHandlingCategory" : {
"uuid" : "2222",
"categoryName" : "TP",
"replaceLinks" : false,
"renderMarkdown" : true,
"erHandlingCategory" : {
"id" : 114,
"name" : "TP",
"failureLimitPerMin" : 10,
"responsibles" : "TP@dbx.hu",
"punishmentMins" : 10
}
},
"layout" : {
"uuid" : "2222",
"name" : "TP",
"description" : "TP",
"createdAt" : "2018-07-18T15:39:41.000+0000",
"htmlContent" : "<html><head><meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8\"/></head><body>${content}</body></html>"
},
"templateVersionList" : [ ],
"assetList" : [ ],
"cgParamList" : {
"cgParam" : [ {
"id" : 7254,
"key" : "LAYOUT",
"value" : "183",
"objectType" : "template",
"objectId" : "TP"
} ]
},
"customData" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<listTemplateParamResp>\r\n <categoryList/>\r\n <customXml></customXml>\r\n <documents>\r\n <document>\r\n </document>\r\n </documents>\r\n <templateDynamicParamList/>\r\n <templateName>TP</templateName>\r\n</listTemplateParamResp>\r\n"
} ]
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Date: Thu, 16 May 2019 08:13:53 GMT
server: grizzly/2.2.16
Transfer-Encoding: chunked
{
"data" : {
"type" : "emptyResponse",
"id" : "856ed045-3d37-435b-b9fe-7add749a6dee",
"attributes" : { }
},
"meta" : {
"total" : null,
"responseStatus" : {
"code" : 0,
"messages" : [ ]
},
"params" : [ ]
}
}
Find mail links
Visszaadja a megadott levélsablonhoz tartozó linkeket.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kéréshez tartozó metaadatok. |
| offset | Integer | A találati lista kezdete. |
| limit | Integer | Megjelenítendő linkek száma. |
| messageTypeCode | String | A sablontípus kódja. |
| templateVersionNumber | Integer | A sablon verziószáma. |
| templateVersionUuid | String | A sablonverzió UUID-je. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| mailLinks | WMailLink1 [ ] | A megtalált linkek. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:findMailLinks>
<!--Optional:-->
<request>
<!--Optional:-->
<requestMeta>
<!--Optional:-->
<clientHashKey>{{clientHashKey}}</clientHashKey>
<!--Optional:-->
<userName>admin</userName>
</requestMeta>
<messageTypeCode>link_teszt</messageTypeCode>
<!--Optional:-->
<templateVersionNumber>2</templateVersionNumber>
</request>
</v4:findMailLinks>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body>
<ns3:findMailLinksResponse xmlns:ns2="http://template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v3.template.api.hammy.dbx.hu/" xmlns:ns5="http://v2.template.api.hammy.dbx.hu/">
<response>
<status>
<code>0</code>
<messages/>
</status>
<mailLinks>
<uuid>43963786-d606-40c8-98fb-f744bfb689e3</uuid>
<title>Google</title>
<realLink>https://google.hu</realLink>
</mailLinks>
<mailLinks>
<uuid>29b37467-d157-4c80-8770-c058c86648e0</uuid>
<title>Twitter</title>
<realLink>https://twitter.com</realLink>
</mailLinks>
<mailLinks>
<uuid>c06b7693-f211-473f-9ac5-2067eb2ed58a</uuid>
<title>Van-e net?</title>
<realLink>https://vanenet.hu</realLink>
</mailLinks>
<mailLinks>
<uuid>b4bc85d6-5cb2-4f90-8f3f-0b1cd73ba8cf</uuid>
<title>Dbx</title>
<realLink>https://dbx.hu</realLink>
</mailLinks>
</response>
</ns3:findMailLinksResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/mailLinks
| Paraméter | Típus | Leírás |
|---|---|---|
| messageTypeCode | String | A keresett sablon kódja. |
| templateVersionNumber | Integer | A keresett verzió száma. |
| templateVersionUuid | String | A keresett verzió UUID-ja. |
| limit | Integer | Megjelenítendő elemek maximális száma. |
| offset | Integer | Melyik elemtől kezdődjön a megjelenítés. |
| clientHashKey | String | A hívó kliens azonosítója. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JMailLink1 [ ] | A megtalált linkek. |
Minta
GET {{baseUrl}}/json/template/v4/mailLinks?templateVersionUuid=4ed6eb03-7b7c-4aeb-927a-e7ac6e5d2dc8
X-Client-Hash-Key: {{clientHashKey}}
uthorization: JWT {{jwtToken}}
X-User-Name: {{UserName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "mailLinks",
"id": "43963786-d606-40c8-98fb-f744bfb689e3",
"attributes": {
"title": "Google",
"realLink": "https://google.hu"
}
},
{
"type": "mailLinks",
"id": "c06b7693-f211-473f-9ac5-2067eb2ed58a",
"attributes": {
"title": "Van-e net?",
"realLink": "https://vanenet.hu"
}
},
{
"type": "mailLinks",
"id": "b4bc85d6-5cb2-4f90-8f3f-0b1cd73ba8cf",
"attributes": {
"title": "Dbx",
"realLink": "https://dbx.hu"
}
}
],
"meta": {
"total": 3,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
List variable constraints
Változómegkötések lekérése.
Egyezőség
A key és value esetén prefix egyezőséget is kihasználhatunk, míg az operator és type esetén csak teljes egyezőséget.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| key | String | A megkötés kulcsa. | |
| operator | String | A megkötés operátora. | |
| variable | String | A megkötés változója. | |
| value | String | A megkötés értéke. | |
| type | String | A megkötés típusa. | |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| constraints | WVariableConstraint1 [ ] | A megkötések. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:listVariableConstraints>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
</request>
</v4:listVariableConstraints>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:listVariableConstraintsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<constraints>
<constraint>
<key>mandatory_constraint_to_ekomm</key>
<operator>EQUAL</operator>
<value>1</value>
<errorMessage>A változó kötelező ha az elektronikus kommunikáció be van pipálva!</errorMessage>
<type>MANDATORY</type>
<variable>wrong</variable>
</constraint>
<constraint>
<key>create-test-constraint-2</key>
<operator>REGEX</operator>
<value>.*</value>
<errorMessage>Error!</errorMessage>
<type>VALID</type>
<variable>test</variable>
</constraint>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length minimum is 3!</errorMessage>
<type>VALID</type>
<variable>test</variable>
</constraint>
<constraint>
<key>name-valid-min-5-length</key>
<operator>MINLENGTH</operator>
<value>5</value>
<errorMessage>Name must be at least 5 long!</errorMessage>
<type>valid</type>
</constraint>
<constraint>
<key>email_address_constraint_to_ekomm</key>
<operator>EQUAL</operator>
<value>1</value>
<errorMessage>A változó kötelező ha az elektronikus kommunikáció be van pipálva!</errorMessage>
<type>mandatory</type>
<variable>ekomm</variable>
</constraint>
</constraints>
</response>
</ns3:listVariableConstraintsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/variableConstraints
| Paraméter | Típus | Leírás |
|---|---|---|
| key | String | A megkötés kulcsa. |
| operator | String | A megkötés operátora. |
| variable | String | A megkötés változója. |
| value | String | A megkötés értéke. |
| type | String | A megkötés típusa. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JVariableConstraint1 [ ] | A megtalált megkötések. |
Minta
GET /hammy/json/template/v4/variableConstraints
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "variableConstraints",
"id": "mandatory_constraint_to_ekomm",
"attributes": {
"operator": "EQUAL",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"type": "MANDATORY",
"variable": "wrong"
}
},
{
"type": "variableConstraints",
"id": "name-valid-min-5-length",
"attributes": {
"operator": "MINLENGTH",
"value": "5",
"errorMessage": "Name must be at least 5 long!",
"type": "valid"
}
},
{
"type": "variableConstraints",
"id": "email_address_constraint_to_ekomm",
"attributes": {
"operator": "EQUAL",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"type": "mandatory",
"variable": "ekomm"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Show variable constraint
Egy változómegkötés lekérdezése.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| key | String | A keresett megkötés kulcsa. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| constraint | WVariableConstraint1 | Keresett megkötés. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:showVariableConstraint>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<key>ws-create-test</key>
</request>
</v4:showVariableConstraint>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:showVariableConstraintResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length minimum is 3!</errorMessage>
<type>VALID</type>
<variable>test</variable>
</constraint>
</response>
</ns3:showVariableConstraintResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/template/v4/variableConstraints/{{key}}
| Név | Típus | Leírás |
|---|---|---|
| key | String | Keresett megkötés kulcsa. |
Válasz
| Típus | Leírás |
|---|---|
| JVariableConstraint1 | Keresett megkötés. |
Minta
GET /hammy/json/template/v4/variableConstraints/{{key}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "variableConstraints",
"id": "mandatory_constraint_to_ekomm",
"attributes": {
"operator": "EQUAL",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"type": "MANDATORY",
"variable": "wrong"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Create variable constraint
Létrehoz egy változómegkötést.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| constraint | WVariableConstraint1 | A létrehozandó megkötés. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| constraint | WVariableConstraint1 | A létrehozott megkötés. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:createVariableConstraint>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length minimum is 3!</errorMessage>
<type>VALID</type>
<variable>test</variable>
</constraint>
</request>
</v4:createVariableConstraint>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:createVariableConstraintResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length minimum is 3!</errorMessage>
<type>VALID</type>
<variable>test</variable>
</constraint>
</response>
</ns3:createVariableConstraintResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/template/v4/variableConstraints
body: JVariableConstraint1
Válasz
| Típus | Leírás |
|---|---|
| JVariableConstraint1 | A létrehozott megkötés. |
Minta
POST /hammy/json/template/v4/variableConstraints
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"id": "mandatory_constraint_to_ekomm",
"type": "variableConstraints",
"attributes": {
"type": "MANDATORY",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"operator": "EQUAL",
"variable": "ekomm"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "variableConstraints",
"id": "mandatory_constraint_to_ekomm",
"attributes": {
"operator": "EQUAL",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"type": "MANDATORY",
"variable": "ekomm"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Update variable constraint
Változómegkötés módosítása.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| constraint | WVariableConstraint1 | A módosítandó megkötés. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| constraint | WVariableConstraint1 | A módosított megkötés. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
| status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:updateVariableConstraint>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length should be longer than 3!</errorMessage>
<type>VALID</type>
<variable>test-modified</variable>
</constraint>
</request>
</v4:updateVariableConstraint>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:updateVariableConstraintResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<constraint>
<key>ws-create-test</key>
<operator>MINLENGTH</operator>
<value>3</value>
<errorMessage>The length should be longer than 3!</errorMessage>
<type>VALID</type>
<variable>test-modified</variable>
</constraint>
</response>
</ns3:updateVariableConstraintResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/template/v4/variableConstraints/{{key}}
body: JVariableConstraint1
| Név | Típus | Leírás |
|---|---|---|
| key | String | Módosítandó megkötés kulcsa. |
Válasz
| Típus | Leírás |
|---|---|
| JVariableConstraint1 | A módosított megkötés. |
Minta
PUT /hammy/json/template/v4/variableConstraints/{{key}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"id": "mandatory_constraint_to_ekomm",
"type": "variableConstraints",
"attributes": {
"type": "MANDATORY",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"operator": "EQUAL",
"variable": "ekomm"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "variableConstraints",
"id": "mandatory_constraint_to_ekomm",
"attributes": {
"operator": "EQUAL",
"value": "1",
"errorMessage": "A változó kötelező ha az elektronikus kommunikáció be van pipálva!",
"type": "MANDATORY",
"variable": "ekomm"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete variable constraint
Sablon változó megkötés törlésére szolgál.
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| key | String | A törlendő megkötés kulcsa. | * |
| clientHashKey | String | A hívó kliens azonosítója. | * |
| params | Param_V1 [ ] | Egyéb paraméterek listája. | |
| userName | String | A felhasználó neve. |
Válasz
| params | Param_V1 [ ] | Egyéb paraméterek listája. | | status | ResponseStatus_V1 | A válasz státusza. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4.ws.service.template.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<v4:deleteVariableConstraint>
<request>
<clientHashKey>{{clientHashKey}}</clientHashKey>
<key>ws-create-test</key>
</request>
</v4:deleteVariableConstraint>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://v3.template.api.hammy.dbx.hu/" xmlns:ns3="http://v4.ws.service.template.api.hammy.dbx.hu/" xmlns:ns4="http://v2.template.api.hammy.dbx.hu/" xmlns:ns5="http://template.api.hammy.dbx.hu/">
<ns3:deleteVariableConstraintResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns3:deleteVariableConstraintResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/template/v4/variableConstraints/{{key}}
| Név | Típus | Leírás |
|---|---|---|
| key | String | Törlendő megkötés kulcsa. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE /hammy/json/template/v4/variableConstraints/{{key}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "816faeac-f3a2-4c06-9054-eb03d08f5119",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
List template variables
Sablon változóinak listázása.
REST API
Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.
REST API
Kérés
GET hammy/json/template/v4/templateVariables
| Paraméter | Típus | Leírás |
|---|---|---|
| messageTypes | String [ ] | A keresett sablontípusok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTemplateVariable1 [ ] | A megtalált változók. |
Minta
GET /hammy/json/template/v4/templateVariables
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Query params:
--------------------------
messageType=message type lista
{{hammy-base}}/json/template/v4/templateVariables?messageTypes%5B%5D=A&messageTypes%5B%5D=PDF_SABLON_01
HTTP/1.1 200 OK
Content-Type: application/json
{
"meta": {
"responseStatus": {
"code": 0,
"messages": []
},
"params": []
},
"list": [
{
"variable": "elektronikus_komminikacio3"
},
{
"variable": "uj_fizetesi_mod1",
"valueType": "checkbox"
},
{
"variable": "elektronikus_szamla2",
"valueType": "select"
},
{
"variable": "elektronikus_szamla1"
},
{
"variable": "szerzodo_neve"
},
{
"variable": "szerzodesszam2"
},
{
"variable": "szerzodesszam3"
},
{
"variable": "szerzodo_mobiltelefonszama"
},
{
"variable": "jelenlegi_fizetesi_mod1"
},
{
"variable": "elektronikus_szamla3"
},
{
"variable": "szerzodo_anyja_neve"
},
{
"variable": "elektronikus_komminikacio1"
},
{
"variable": "elektronikus_komminikacio2",
"valueType": "datetime"
},
{
"variable": "szerzodesszam1"
},
{
"variable": "szerzodo_email_cime"
},
{
"variable": "szerzodo_szuletesi_datuma"
},
{
"variable": "just_kod",
"valueType": "phone"
},
{
"variable": "szerzodo_szuletesi_helye",
"valueType": "phone"
}
]
}