Kihagyás

Template API V1

HammyTemplateAPI WSDL letöltése

List assets

Visszaadja a rendszerben mentett, a sablonokban használható képek listáját.

Web service API

Kérés

Név Típus Leírás Kötelező
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
assetList WAsset1 [ ] A levélhez tartozó képek 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:listAssets>
         <request>
            <clientHashKey>xx</clientHashKey>
         </request>
      </tem:listAssets>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listAssetsResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <assetList>
               <asset>
                  <assetId>61</assetId>
                  <category>1</category>
                  <data>/9j/4AAQSkZJRgABAQ...</data>
                  <description>Proba</description>
                  <fileName>mittom.jpg</fileName>
                  <mimeType>image/jpeg</mimeType>
                  <type>IMAGE</type>
                  <uuid>61</uuid>
               </asset>
               <asset>
                  <assetId>44</assetId>
                  <category>signatureFiles</category>
                  <description>Basic Signature File</description>
                  <fileName>signo_old</fileName>
                  <mimeType>image/png</mimeType>
                  <type>IMAGE</type>
                  <uuid>44</uuid>
               </asset>
               <asset>
                  <assetId>43</assetId>
                  <category>signatureFiles</category>
                  <description>Basic Signature File</description>
                  <fileName>signo_old</fileName>
                  <mimeType>image/png</mimeType>
                  <type>IMAGE</type>
                  <uuid>43</uuid>
               </asset>
               <asset>
                  <assetId>1</assetId>
                  <description>Logo PDF-re</description>
                  <fileName>PDF_LOGO</fileName>
                  <mimeType>image/jpeg</mimeType>
                  <type>IMAGE</type>
                  <uuid>1</uuid>
               </asset>
               <asset>
                  <assetId>22</assetId>
                  <fileName>PDF_LOGO_3.jpg</fileName>
                  <mimeType>image/jpeg</mimeType>
                  <type>IMAGE</type>
                  <uuid>22</uuid>
               </asset>
               <asset>
                  <assetId>21</assetId>
                  <fileName>PDF_LOGO_1</fileName>
                  <mimeType>image/jpeg</mimeType>
                  <type>IMAGE</type>
                  <uuid>21</uuid>
               </asset>
            </assetList>
         </response>
      </ns2:listAssetsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/assets

Paraméter Típus Leírás
id String A kérés azonosítója. (vnd.api ID)
fileName String A keresett file neve.
type String A keresett file típusa.
category String A keresett file kategóriája.
limit Integer A keresési találatok maximális száma.
offset Integer A találati lista kezdete (pl. resultSize = 10 és offset = 1, akkor a teljes találati lista 11. elemétől a 20. eleméig tartó listát adja vissza).
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 JAsset1 [ ] A megtalált képek.

Minta

GET /hammy/json/template/v1/assets?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": "assets",
            "id": "{{uuid}}",
            "attributes": {
                "fileName": "filename.png",
                "category": "Kategoria1",
                "mimeType": "image/png",
                "description": "desc_asset"
            }
        }
    ],
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show asset

Visszaadja a megadott azonosítójú sablonban használható képet.

Web service API

Kérés

Név Típus Leírás Kötelező
assetId Integer A levélhez tartozó kép azonosítója.
fileName String A file neve.
extendedAssetId String Azonosító, file kiterjesztéssel.
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
asset WAsset1 A keresett kép.
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:showAsset>
         <request>
            <clientHashKey>?</clientHashKey>
         </request>
      </tem:showAsset>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showAssetResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>2</code>
               <messages/>
            </status>
         </response>
      </ns2:showAssetResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/assets/{{uuid}}

Név Típus Leírás
uuid String A keresett asset UUID-ja.

Válasz

Típus Leírás
JAsset1 A keresett asset.

Minta

GET /hammy/json/template/v1/assets/{{uuid}}?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": "assets",
        "id": "{{uuid}}",
        "attributes": {
             "fileName": "filename.png",
             "category": "Kategoria1",
             "mimeType": "image/png",
             "description": "desc_asset"
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show asset content by UUID

Visszaadja a megadott azonosítójú sablonban használható kép tartalmát.

REST API

Ez a funkció csak REST API-n hívható, Web service-n a Show asset a tartalmat is visszaadja.

REST API

REST API Info

Kérés

GET hammy/json/template/v1/assets/{{uuid}}/content

Név Típus Leírás
uuid String A levélhez tartozó kép UUID-ja.

Válasz

A képet a body Byte [ ]-ként tartalmazza, a megfelelő MIME type-ot a header.

Minta

GET /hammy/json/template/v1/assets/{{assets.id}}/content?clientHashKey={{clientHashKey}}
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

Létrehoz egy sablonokban használható képet.

Web service API

Kérés

Név Típus Leírás Kötelező
asset WAsset1 A létrehozandó kép. *
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
asset WAsset1 A létrehozott kép.
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:createAssets>
         <request>
            <clientHashKey>x</clientHashKey>
            <userName>x</userName>
            <asset>
               <assetId>74</assetId>
               <category>signatureFiles</category>
               <data>cid:286529913611</data>
               <description>Basic File</description>
               <fileName>Minta</fileName>
               <mimeType>image/jpeg</mimeType>
            </asset>
         </request>
      </tem:createAssets>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createAssetsResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <asset>
               <assetId>97</assetId>
               <category>signatureFiles</category>
               <data>/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAAAeAAD/7gAOQWRvYmUAZMAAAAAB/9sAhAAQCwsLDAsQDAwQFw8NDxcbFBAQFBsfFxcXFxcfHhcaGhoaFx4eIyUnJSMeLy8zMy8vQEBAQEBAQEBAQEBAQEBAAREPDxETERUSEhUUERQRFBoUFhYUGiYaGhwaGiYwIx4eHh4jMCsuJycnLis1NTAwNTVAQD9AQEBAQEBAQEBAQED/wAARCAD6APoDASIAAhEBAxEB/8QAiwAAAwEBAQEBAAAAAAAAAAAAAAECAwQFBgcBAQEBAQEBAAAAAAAAAAAAAAABAgMEBRAAAgEDAwMCBAUDAwUAAAAAAAECESEDMUEEURIFYRNxgSIyQlIjFAaRwWKhMxWx0fFyghEBAQACAQMDAwUBAQAAAAAAAAERAgMhMRJBUQRhgZFxIjJCE7FS/9oADAMBAAIRAxEAPwD9AAAAAAAAAAAAAAAAAAAAAAAAAAAABAAwEADAQwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAVABiqKrAYC7l1Qnkh+Zf1JkUS3S+25M82OEHOU0oxu3VWPkPPfyKefI+PxJ9nHhaU1Zzf/AGMcnJrpM38Na6Xa4n5er5X+V8LguWLFXPnVu2K+lfM8rw/8o5U/Ir98/wBHkKkbWg62MvGfx3P5GCzZG8eCV039z9T2sH8S4GHJjn3zn7V1FuxjW8m2NsYns3f89czvXup1VVo7oZKSVtlZIo7uRgAAAAAAAAAAAAAAAAAAACGIAAKnNyefxuLGuadH+VXZLZO46QqeDyP5G9ONi+EpnnZ/L+RzVUsriukbHLbn0nbr+hh9Xl5GHDFyyzUEurODN/IODjdIN5H/AIo+VnknN1m3N9ZMz9yj6HLb5O39ZhrxfRz/AJLr2YPh3Mwn/IOfL7Iwh/qeJHNTU3x5YTtucL8jl/8AWDDtl5fyktctF6KhlLlcvI65M836VoZqRUUq+hi8u977X8kRNZX+OT+bCMZ0q2161Z0rsdDl8hnWDA1H756L06mPPa3vfysmbiODncqTbxQlLt3u7voPieP7orLnVa3jj/uzXxPC9xvl5F3RVsae73Z6c49rVqV3LdrOk7t7bYnjr2Zwz8rEkoZpxS0inY1h5nyWJ/7qmv8AJHNOVzGTrexvXk5J22rl5Zr28H8matyMP/1Bnq8XynD5a/SyLu3g7M+NqthJ0aatJaNHfT5G8/l1XEffVA+U4Pnc/GpjzfrYvX7ke5xPL8LlUjDJ2z/JKzPTry67eqYd4CTQ6nRDAQwAAAAAAAAAAEKUoxTlJ0S1YSkoqr0Wp8/5XybzN4cTpjX3Pqc+TkmkzfsNfIeZdXi4rp+bI/7HjTnKUnKT7pPdiu9DXFgbdXc8HJy7bdbfszm24jFRlK4/Zrd1OpxSskJp0ojl5tSe7jeBMznxlqrHb2NfcyWk7Cb1Y82eKSMn7uN90b0PUlCPS5m8Sexryl7rlyY+ZXXX1OqGfuiZz4OOV2qP0Ijw3B1jJ/MdDHtXZiyVrc83yM3yeXjww1bUV8Nzrx48irf5kYuBKPK/cufdJJqKppXUmskubV1uM16aWLBihCNFGCol6nNm5LnKiVinjlJJSdloL24oTGWNs1zScnohPHPqdPaq0FKF7XL5T0Zw5HjmtyXGS3OtqPQznFmpsua5qyQ1N7amnZUPbewndryd3B87y+JSE372H8stV8GfTcHyXF5sO7FKk/xY3qj4pYnua43kxSU8MnDIt1qejj5ttel6w6PvEwPI8T5hclLByGo5lo9O49dHq12m0zEMBDNAAAAQARmyLFjlN6RVfmS3A83zXL7Ift4Okpfc/Q8HtbZvycs8+VzleugYsd6Nanzefl8trfT0ZvW4LDiqdMccloaYcSTOmOFLU8/W10116ORYE9bh+3TlRunRHcsKemwLEk06VY8W/Fw/tGjKeKMWepKNdTnniTnRRr1F1x2TDzZY6OyJ9ur1O/Jh6I5njak6XYlZsYvHsT2U2NpqWlLjWNpVdy+TOGcFvSiKlDdFSi6KjoUoOxLV+jKEe4bgnY1UGn6bkySTqMmGDjSsdzPtlF0dzeVaWI13LGcIatoZSszdmUopmoVlZhuVKOyFS1zeUONLlKKIRSZqbNyLUVrWj2pqfReI8h7+NYcr/VgrP8yPnourN8OSWKay43SUTtx8njf+j60Zhxs8eRhjlj+JXXRmx7ZczKGAAAjz/MZXDjqC1mz0GeL5nI5Zo41pFVZx+Rt48e316DzFGsjrxQq16GOKH1XOrCj5VvU1jWK7b7vQ1hF7shpOia3NYuhZHVSdNAWtwWo61saImS6Bog+vusl2jdl6kVlNVOaeNJtnS5Ot0Z5bqxmpY5exvUrttShopJr1RLnehEwzcUru66CtXShpKSfxM+1S12CClV1MsrcdFU37a6W+JMov5EMdHP8AVS+5Hakrmz7XYiSsWVMMmnsZ9ybfobU2J7Ero1KM5IXaaNVE0jUqYZUGkVRAqFlWCKpY1h0ZnvYtdTprR63huT25JYZOkZXj8T2z5TDOUJRmtU7H1GHJ7mKM+qTPbw7Z1x7JWgCGdkJnz/Nl38iT+R783SLfRM+cySrlbe7PL8u/skDgjWL7X6GVtdi402vU+Zs1G8J10dkappqpzQTVtjSD7bIs2bbxk6lVVGZKd0aVoblDVhXYu2su645WQVLtqYza1NGjHIpRq0Zoj6VffoQ6Suth1e4mlToYlZJyindExaehdVS5CS1QyYO5LqqlqNgaVBTDDtWqJnGqaZq0qGc2oqolLGahRfAlmiaatoTSjN5Rm02JlifQsRFBNNFCaKFXQtEoo1rWr2WnQ+g8Rl9ziJPWDp8j56tD2PBTqssPVNHs+Pf3fqzXsIYhnrZTP7X8GfOSX1v4s+kZ89ni1nmv8jyfMn7YFRTXbuOMXFUGo0uFb23Pm1pcG6Xeg6rrcUUhaOpnEaytSvc1UmYN1aroXezroazhY6O9WE29jLu0qV3tmpsom3Su5i25KjNZNUMq60RnaiHVMzyemppKupFIu5jsMlKWjuVFUfxKaVNBRgk63LakjRdBuKGktSZO303DeGclczkk1Q2adKszoipZllSllYikq3NJEN3oajGEOi0JKaEaiJ3FL0Bq+onYqJXcrMtP1Jd7gixWiaZ63gnTNNf4nkRPW8H/AL8//U9XB/OJXuoYhnuZJnjeSx9nITWklX5nsnneXhXFHIvwun9Tj8jXPHfp1HFF/Tch0iKNGgd9dj5F7t5zD7rVNK0SM4uLsUmqOpCHKS+QRyJ2WxMkq2Qoq9kRY1brqFdhO66UIq6EaaKS+IvVEJJDcnoUTOuxnHvrfQtktUYRethwjcmNamiVw3IralKioq2sNugm7VDSJa0MpRozSTojJyTDNRJmcq6ouZFTUYqG6kt9CpO9Ca3obZIloqQiom4VoMWrLBUbnteBV8sulEeNFJbHv+ChTjSn+aX/AEPV8aZ3iV6gxDPchGPJxLLgnDqrfFGwEszLPcfOUabT1Woq3OryOL2uR3JfTNf6nG3eux8jl08d7PZcrToxp3oJNU1Fpc41V91Li7mmQ25WoVVa9CWLKam2rop01RCaabQVkFypu1iXJ1FKrTVfgRelxgtX3VBshSSCtdC4JWsaddSu+MWk3dmS0Ct/XYjcrdyrfoTKaoRV0ruQ5MLk2zNJKtFZlN1JboGbUyZDRUr6kVNRKlgKku6o6mmUv1FToMTNQJsSBpagWI0SsfT+Nxe1w8cd2u5/M+b4mKWbPDEt3f4H1sIqMVFWSVD3fF177fZKoYhnqQgGAHH5DB72BtfdC6PD9HY+marZ3T1PD8hxnhy1S+ibseP5fHmec+45qqvwG29ib/0Cp8+xpSrQaq7aEq24qpMzVjSytXUTbVqiRLdyYMqYm7Cqxd1dSoTvsC9Ak3sTV/ACu5gpVZnJ9vqCb1LhZW1aEyZNXUG6qgwuR3XoEnS5NNyZN7jCZNzqTVkKta7FVNYDruLUTE2WBuiJYNkuSRYgdxabiciYqWScccLyk6JG9YmXt/x/B3SnyXt9MT3e44+HijxeNjwr8K+p9XubqZ9Pj08dJEbVCpn3h3GxsAAAjn5nHXIwuP4leJ0BQlkssvqPmZRlCTjJUkrNEux63k+G5r3sauvuSPJdrM+XzcV02+nooTQSpqJugu44WKuLsTMO4mTIHV0uJSqTVsEVMr2Il6MfcS30GDJ91FcE6k3eoKxcGVak6A29EK5FyJNrYGw7thS0LIiaircKiqawZU5Lchy6CbIcjUhlTmS5MhyInLepqas2qnP/AMnqeF41HLl5PhjX9zzOLglysnb+Bfcz3ozjCKhG0YqiPX8fi6+V7Qjt971Gspw+96jWb1PUr0I5SvdOGOUr3QPZAAABDEANKh5XkOBRPNiVvxRPVE6aPcxvpN5ij5WTaEevz/HKf6uFUktYdTyJwcG1JUe587l4bpeoXcJyE/Qls5ePVMqTE5UZNWKtS4S1dUwqQCZMGV96E2Q5RqOqGFypyJcydGJyegwZaVJcxN2sZtmpC1TkS5EuTIc+hqas5U5ENkymZuRuap5LlKhMYyy5Fjhq7v0Rm5OTors7uLBYY1/G9X/Y68fHm/RZMuzBGPHxrHHe8n1NPcOdTqUqs9k6dI227ylNmaiy4wZoaqbK72THHU09pgfQgAEAIYgBkMtktARJ0OLlcbDnX1KktpLU7JI58kWS6yzFmR43I4eTFdfVHqjjkmnex7eVM4ORGuqPNv8AG1/rcJY4Wxdw8iUTFziefbi2nozZWncPuZkpdKD7jPimVuRPcyHIXcPFMte8lyRn3oTmWank17yHMz76Il5F1LNUzWkpGbkZyyCSyStFGpquKbkSlKbov6m2PiTk6yv6HZi4UqWVDpro1NPdzYcXYqq8up0QhJ7Hbi4EqaHXi4HVHfXVvt2efjwyZ0QwM9GHBpsbx4iWx0kHnQ47N4cb0O+PHSNI4UUcUOP6Gn7ddDsWOg+wDQAAAAAAQmhgBDiZygb0E0Bx5MNTly8Sux6rgS8aexKPBycCuxzT8a3sfSPCnsS+PHoZ8YPln4zItLES8fmWh9X+2j0E+LDoZukp09nyUuByDN8Dk9T7D9pDoH7OH5Sf5T2hiez43/jeS92P/i+R1Z9l+0h0GuJDoP8AOexiPjl4nO+prHwuR6o+tXFgtilx49B/mdHy+PwrWqOvF4dLVHvrDFbFLFEs44ryMfjIrY6ocGC2O5QQ6I1NYjnhxorY1WKKNKAbwJ7EOgwAKIKDAAAAAAAAAAAAAAABDABAMAFQKAABRCoMACiCiACBUHQAHQFAoADoAAGUAAAAAAAAAAAAAAAAB//Z</data>
               <description>Basic File</description>
               <fileName>Minta</fileName>
               <mimeType>image/jpeg</mimeType>
               <uuid>ca93b88d-4205-416b-b8a8-415443483444</uuid>
            </asset>
         </response>
      </ns2:createAssetsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/template/v1/assets

A kérés egy multipart/form-data. Az asset nevű részben kell az asset json leíróját, az asset_data részben pedig az asset byte content-jét küldeni.

Multipart név Tartalom Leírás
asset JAsset1 A létrehozandó asset adatai.
asset_data application/octet-stream Az asset tartalma.

Válasz

Típus Leírás
JAsset1 A létrehozott asset.

Minta

POST /hammy/json/template/v1/assets?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="asset"

{
    "data": {
            "id" : "{{uuid}}",
            "type": "assets",
            "attributes": {
                "fileName": "filename2.png",
                "category": "Kategoria1",
                "mimeType": "image/png",
                "description": "desc_asset 2"
            }
        }
}
{{boundary}}
Content-Disposition: form-data; name="asset_data"
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" : "assets",
    "id" : "{{uuid}}",
    "attributes" : {
      "fileName" : "filename2.png",
      "category" : "Kategoria1",
      "mimeType" : "image/png",
      "description" : "desc_asset 2"
    }
  },
  "meta" : {
    "total" : null,
    "params" : [ ],
    "responseStatus" : {
      "code" : 0,
      "messages" : [ ]
    }
  }
}

Delete asset

Törli a megadott képet.

Web service API

Kérés

Név Típus Leírás Kötelező
assetId Integer A törlendő asset azonosító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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:deleteAsset>
         <!--Optional:-->
         <request>
            <clientHashKey>x</clientHashKey>
            <!--Optional:-->
            <userName>x</userName>
            <assetId>97</assetId>
         </request>
      </tem:deleteAsset>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:deleteAssetResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
         </response>
      </ns2:deleteAssetResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

DELETE hammy/json/template/v1/assets/{{uuid}}

Név Típus Leírás
uuid String A törlendő asset UUID-ja.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta

DELETE /hammy/json/template/v1/assets/{{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",
        "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ő
templateKindFilter TemplateKind A paraméter azt szabályozza, hogy a hívás milyen típusú sablonokat adjon vissza.
statusListFilter String [ ] Szűrési feltételek a sablonok státuszára.
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 WMessageType1 [ ] A üzenettípusokat tartalmazó lista.
layoutList WLayout1 [ ] A sablon kereteket 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://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/">
   <S:Body>
      <ns2:listMessageTypesResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <messageTypeList>
                <messageType>
                   <messageTypeCode>320.CT</messageTypeCode>
                   <description>GB320 Dynamique Casco törlésértesítő</description>
                   <status>ENABLED</status>
                   <createdAt>2018-01-11T16:37:18.931Z</createdAt>
                   <updatedAt>2018-01-12T16:37:18.931Z</updatedAt>
                   <layoutId>1</layoutId>
                </messageType>
                <messageType>
                   <messageTypeCode>322.CT</messageTypeCode>
                   <description>GB322 A100 Casco törlésértesítő</description>
                   <status>ENABLED</status>
                   <createdAt>2018-01-11T16:37:18.931Z</createdAt>
                   <updatedAt>2018-01-12T16:37:18.931Z</updatedAt>
                   <layoutId>1</layoutId>
                </messageType>
                <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-12T16:37:18.931Z</updatedAt>
                   <layoutId>2</layoutId>
                </messageType>
            </messageTypeList>
            <layoutList>
                <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>
                <layout>
                    <id>2</id>
                    <name>senior_casco_layout</name>
                    <description>Senior Casco levelek Layout-ja</description>
                    <createdAt>2018-01-11T17:37:18.931Z</createdAt>
                    <htmlContent><![CDATA[
                       <h1>XXX Biztostito CASCO SENIOR</h1>
                       <p>#DATA</p>
                        ]]>
                    </htmlContent>
                </layout>
            </layoutList>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>                
         </response>
      </ns2: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/v1/messageTypes

Paraméter Típus Leírás
skipLayouts Boolean Ne használjon sablon keretet.
templateKindFilter TemplateKind [DEPRECATED] Szűrési feltétel, a templateKinds használandó.
templateKinds TemplateKind [ ] A keresett sablon típusok.
statuses String [ ] 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.

Ha a templateKindFilter meg van adva, akkor ez a feltétel bekerül a templateKinds értékei mellé.

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JMessageType1 [ ] A megtalált sablonok.

Minta

GET /hammy/json/template/v1/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 WMessageType1 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 WLayout1 Az új üzenet sablon kerete.
messageType WMessageType1 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:createMessageType>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageType>
               <createdAt>?</createdAt>
               <description>GB370 Senior casco törlésértesítő</description>
               <layoutId>1</layoutId>
               <messageTypeCode>370.CT</messageTypeCode>
               <status>?</status>
               <templateKind>?</templateKind>
               <updatedAt>?</updatedAt>
            </messageType>
         </request>
      </tem:createMessageType>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createMessageTypeResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <messageType>
               <messageTypeCode>370.CT</messageTypeCode>
               <description>GB370 Senior casco törlésértesítő</description>
               <status>DISABLED</status>
               <createdAt>2018-01-11T16:37:18.931Z</createdAt>
               <updatedAt>2018-01-11T16:37:18.931Z</updatedAt>
              <layoutId>1</layoutId>
            </messageType>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>                
           <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>
         </response>
      </ns2:createMessageTypeResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/template/v1/messageTypes

body: JMessageType1

Válasz

Típus Leírás
JMessageType1 A létrehozott típus.

Minta

POST /hammy/json/template/v1/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",
        "layoutId" : null,
        "templateHandlingCategory" : 5,
        "templateHandlingCategoryName" : "Default",
        "templateKind" : "GENERATE",
        "permissionShowList" : [],
        "permissionListList" : [],
        "canShow" : true
    }
  }
}
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",
            "templateHandlingCategory": 5,
            "templateHandlingCategoryName": "Default",
            "templateKind": "normal",
            "permissionShowList": [],
            "permissionListList": []
        }
    },
    "meta": {
        "total": null,
        "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 WMessageType1 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 WLayout1 Az módosított üzenet sablon kerete.
messageType WMessageType1 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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:updateMessageType>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageType>
               <createdAt>?</createdAt>
               <description>GB370 Senior casco törlésértesítő</description>
               <layoutId>?</layoutId>
               <messageTypeCode>370.CT</messageTypeCode>
               <status>?</status>
               <templateKind>?</templateKind>
               <updatedAt>?</updatedAt>
            </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://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

REST API Info

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/v1/messageTypes/{{messageTypeCode}}

PUT hammy/json/template/v1/messageTypes

body: JMessageType1

Válasz

Típus Leírás
JMessageType1 A módosított típus.

Minta

PUT /hammy/json/template/v1/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

Archiválási funkcióként kerül implementálásra a törlés, azaz megjelenik a felületen minden sablonhoz egy archiválás gomb. A törlés ARCHIVED status-al íródik be a templates táblába, ekkor az archived_at kitöltésre kerül.

Web service API

Kérés

Név Típus Leírás Kötelező
messageTypeCode String A törlendő ü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
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:deleteMessageType>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageTypeCode>URES_TEMPLATE</messageTypeCode>
         </request>
      </tem:deleteMessageType>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:deleteMessageTypeResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
         </response>
      </ns2:deleteMessageTypeResponse>
   </S:Body>
</S:Envelope>

REST API

Kérés

DELETE hammy/json/template/v1/messageTypes/{{messageTypeCode}}

Név Típus Leírás
messageTypeCode String A törlendő üzenettípus azonosítója.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta

DELETE /hammy/json/template/v1/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": "emptyResponse",
        "id": "2794f287-7402-4fab-9de0-bb23494ceb27",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

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 WLayout1 A típushoz tartozó sablon keret.
messageType WMessageType1 [ ] 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:showMessageType>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageTypeCode>320.CT</messageTypeCode>
         </request>
      </tem:showMessageType>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showMessageTypeResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <messageType>
              <messageTypeCode>320.CT</messageTypeCode>
              <description>GB320 Dynamique Casco törlésértesítő</description>
              <status>ENABLED</status>
              <createdAt>2018-01-11T16:37:18.931Z</createdAt>
              <updatedAt>2018-01-12T16: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:showMessageTypeResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

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/v1/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
JMessageType1 A megtalált típus.

Minta

GET /hammy/json/template/v1/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 WMessageType1 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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:setMessageTypeStatus>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageTypeCode>320.CT</messageTypeCode>
            <status>ENABLED</status>
         </request>
      </tem:setMessageTypeStatus>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:setMessageTypeStatusResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <messageType>
              <messageTypeCode>320.CT</messageTypeCode>
              <description>GB320 Dynamique Casco törlésértesítő</description>
              <status>ENABLED</status>
              <createdAt>2018-01-11T16:37:18.931Z</createdAt>
              <updatedAt>2018-01-12T16: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>                
         </response>
      </ns2:setMessageTypeStatusResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/template/v1/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
JMessageType1 A megtalált típus.

Minta

PUT /hammy/json/template/v1/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 WMessageType1 [ ] 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:setMessageTypesStatus>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageTypeCodeList>
               <messageTypeCode>351.E</messageTypeCode>
            </messageTypeCodeList>
            <status>ENABLED</status>
         </request>
      </tem:setMessageTypesStatus>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:setMessageTypesStatusResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <messageTypeList>
               <messageType>
                  <createdAt>2018-09-19T14:47:59.201+02:00</createdAt>
                  <description>GFB kötvény</description>
                  <messageTypeCode>351.E</messageTypeCode>
                  <permissionListList/>
                  <permissionShowList/>
                  <status>ENABLED</status>
                  <templateHandlingCategory>2</templateHandlingCategory>
                  <templateHandlingCategoryName>Strict Error Category</templateHandlingCategoryName>
                  <templateKind>normal</templateKind>
                  <updatedAt>2019-04-15T15:32:48.994+02:00</updatedAt>
               </messageType>
            </messageTypeList>
         </response>
      </ns2:setMessageTypesStatusResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/template/v1/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
JMessageType1 [ ] A módosított üzenettípusok.

Minta

PUT /hammy/json/template/v1/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

Átnevez egy már meglévő üzenettípust. Amennyiben a megadott néven már létezik üzenettípus, akkor a metódus hibát fog jelezni.

Web service API

Kérés

Név Típus Leírás Kötelező
messageTypeCode String Üzenettípus kód. *
newMessageTypeCode String Új üzenettípus kód.
newDescription String Új leírá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
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:renameMessageType>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageTypeCode>351.E</messageTypeCode>
            <newMessageTypeCode>351.EX</newMessageTypeCode>
         </request>
      </tem:renameMessageType>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:renameMessageTypeResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
         </response>
      </ns2:renameMessageTypeResponse>
   </S:Body>
</S:Envelope>

REST API

Kérés

PUT hammy/json/template/v1/messageTypes/rename

Név Típus Leírás
id String A kérés azonosítója. (vnd.api ID)
messageTypeCode String Üzenettípus kód.
newMessageTypeCode String Új üzenettípus kód.
newDescription String Új leírás.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta

PUT /hammy/json/template/v1/messageTypes/rename
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "messageTypeCode" : "URES_TEMPLATE",
    "newMessageTypeCode" : "URES_TEMPLATE_RENAME",
    "newDescription" : "MODOSITOTT"
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "emptyResponse",
        "id": "faba459b-6db4-441b-bb25-7cea90a5d2d1",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Copy message type

Lemásol egy meglévő üzenettípust. Amennyiben a megadott néven már létezik üzenettípus, akkor a metódus hibát fog jelezni.

REST API

Ebben a verzióban ez a funkció csak REST API-n érhető el.

REST API

REST API Info

Kérés

POST hammy/json/template/v1/messageTypes/copy

Név Típus Leírás
id String A kérés azonosítója. (vnd.api ID)
messageTypeCode String Az eredeti üzenettípus kód.
newMessageTypeCode String Új üzenet típus kód.
newDescription String Új leírás.
permissionShowList String [ ] Milyen jogosultságokkal lehet megnézni az üzenetet.
permissionListList String [ ] Milyen jogosultságokkal lehet listázni az üzenetet.
permissionEditList String [ ] Milyen jogosultságokkal lehet szerkeszteni az üzenetet.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta

POST /hammy/json/template/v1/messageTypes/copy
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "messageTypeCode" : "URES_TEMPLATE",
    "newMessageTypeCode" : "URES_TEMPLATE_COPY",
    "newDescription" : "MASOLT"
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "emptyResponse",
        "id": "a190b1b7-4e0b-4180-b22c-99a5bf756963",
        "attributes": {}
    },
    "meta": {
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

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 WTemplateVersion1 [ ] Template 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:listTemplateVersions>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageTypeCode>Q.2</messageTypeCode>
         </request>
      </tem:listTemplateVersions>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns2:listTemplateVersionsResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
      <response>
        <templateVersionList>
          <templateVersion>
            <versionNumber>1</versionNumber>
            <description>letrehozas</description>
            <status>OLD</status>
            <subject>A legjobb termék</subject>
            <htmlBody><![CDATA[<h1>Hello Világ!</h1>]]></htmlBody>
            <plainTextBody># Helló Világ!</plainTextBody>
            <createdAt>2018-01-11T16:37:18.931Z</createdAt>
            <updatedAt>2018-01-12T16:37:18.931Z</updatedAt>
          </templateVersion>
          <templateVersion>
            <versionNumber>2</versionNumber>
            <description>piros háttér</description>
            <status>ACTUAL</status>
            <subject>A legjobb termék</subject>
            <htmlBody><![CDATA[
                <h1>Hello Mester!</h1>
                <p>Olyat mondunk, vásárolni fogsz.</p>
              ]]>
            </htmlBody>
            <plainTextBody>
              # Helló Világ!
              Olyat mondunk, vásárolni fogsz.
            </plainTextBody>
            <createdAt>2018-01-13T16:37:18.931Z</createdAt>
            <updatedAt>2018-01-14T16:37:18.931Z</updatedAt>
          </templateVersion>
          <templateVersion>
            <versionNumber>3</versionNumber>
            <description>piros háttér</description>
            <status>DRAFT</status>
            <subject>A legjobb termék</subject>
            <htmlBody><![CDATA[
                <h1>Hello Mester!</h1>
                <p>Olyat mondunk, vásárolni fogsz.</p>
                <ul>
                  <li>Termék 1</li>
                  <li>Termék 2</li>
                  <li>Termék 3</li>
                </ul>
              ]]>
            </htmlBody>
            <plainTextBody>
              # Helló Világ!
              Olyat mondunk, vásárolni fogsz.
              * Termék 1
              * Termék 2
              * Termék 3
            </plainTextBody>
            <createdAt>2018-01-15T16:37:18.931Z</createdAt>
            <updatedAt>2018-01-16T16:37:18.931Z</updatedAt>
          </templateVersion>
        </templateVersionList>
        <responseStatus>
          <code>0</code>
          <messages/>
        </responseStatus>
        <params>
           <param>
              <key>?</key>
              <value>?</value>
              <ref>?</ref>
        </param>            
      </response>
    </ns2:listTemplateVersionsResponse>
  </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/messageTypes/{{messageTypeCode}}/templateVersions

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JTemplateVersion1 [ ] A megtalált verziók.

Minta

GET /hammy/json/template/v1/messageTypes/{{messageTypes.id}}/templateVersions?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": 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"
            }
        }
    ],
    "meta": {
        "total": null,
        "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 WTemplateVersion1 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:showTemplateVersion>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageTypeCode>320.CT</messageTypeCode>
            <versionNumber>1</versionNumber>
         </request>
      </tem:showTemplateVersion>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showTemplateVersionResult xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <templateVersion>
              <versionNumber>2</versionNumber>
              <description>piros háttér</description>
              <status>ACTUAL</status>
              <subject>A legjobb termék</subject>
              <htmlBody>...</htmlBody>
              <plainTextBody>...</plainTextBody>
              <createdAt>2018-01-13T16:37:18.931Z</createdAt>
              <updatedAt>2018-01-14T16:37:18.931Z</updatedAt>
            </templateVersion>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>                
         </response>
      </ns2:showTemplateVersionResult>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/messageTypes/{{messageTypeCode}}/templateVersions/{{versionNumber}}

Válasz

Típus Leírás
JTemplateVersion1 A keresett verzió.

Minta

GET /hammy/json/template/v1/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": []
        }
    }
}

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 WTemplateVersion1 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 WTemplateVersion1 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:createOrUpdateTemplateVersion>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
            <messageTypeCode>320.CT</messageTypeCode>
            <templateVersion>
               <createdAt>?</createdAt>
               <description>piros háttér</description>
               <htmlBody>...</htmlBody>
               <plainTextBody>?</plainTextBody>
               <status>?</status>
               <subject>A legjobb termék</subject>
               <updatedAt>?</updatedAt>
               <versionNumber>?</versionNumber>
            </templateVersion>
         </request>
      </tem:createOrUpdateTemplateVersion>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createOrUpdateTemplateVersionResult xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>             
            <templateVersion>
              <versionNumber>2</versionNumber>
              <description>piros háttér</description>
              <actual>false</actual>
              <subject>A legjobb termék</subject>
              <htmlBody>...</htmlBody>
              <plainTextBody>...</plainTextBody>
            </templateVersion>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>                 
            <status>
               <code>0</code>
               <messages/>
            </status>
         </response>
      </ns2:createOrUpdateTemplateVersionResult>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

CREATE

POST hammy/json/template/v1/messageTypes/{{messageTypeCode}}/templateVersions

A kérés lehet:

  • multipart/form-data. Az template_version nevű részben a sablon json leíróját (JTemplateVersion1), az template_version_body részben pedig a sablon tartalmát binárisan kell küldeni.
  • application/json. Ha nincs a sablonhoz tartalom, akkor nem kell multipart.
UPDATE

PUT hammy/json/template/v1/messageTypes/{{messageTypeCode}}/templateVersions

A kérés lehet:

  • multipart/form-data. Az template_version nevű részben a sablon json leíróját (JTemplateVersion1), az template_version_body ré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
JTemplateVersion1 Az új verzió.

Minta

POST/PUT /hammy/json/template/v1/messageTypes/{{messageTypes.id}}/templateVersions?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
content-type: multipart/form-data; boundary={{boundary}}
{{boundary}}
Content-Disposition: form-data; name="template_version"
Content-Type: application/json
X-User-Name: {{userName}}

{
    "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" : [ ]
    }
  }
}

List layouts

Visszaadja a rendszerben elmentett sablon keret típusokat és a hozzájuk tartozó jellemzőket.

Web service API

Kérés

Név Típus Leírás Kötelező
ddm Boolean
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
layoutList WLayout1 [ ] A kereteket 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:listLayouts>
         <request>
            <clientHashKey>?</clientHashKey>
            <params>
               <param>
                  <key>?</key>
                  <value>?</value>
                  <ref>?</ref>
               </param>
            </params>
         </request>
      </tem:listLayouts>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listLayoutsResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <layoutList>
                <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>
                <layout>
                  <id>2</id>
                  <name>senior_casco_layout</name>
                  <description>Senior Casco levelek Layout-ja</description>
                  <createdAt>2018-01-11T17:37:18.931Z</createdAt>
                  <htmlContent><![CDATA[
                    <h1>XXX Biztostito CASCO SENIOR</h1>
                    <p>#DATA</p>
                      ]]>
                  </htmlContent>
                </layout>
            </layoutList>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <param>
              <key>?</key>
              <value>?</value>
              <ref>?</ref>
            </param>
         </response>
      </ns2:listLayoutsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/layouts

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JLayout1 [ ] A megtalált keretek.

Minta

GET /hammy/json/template/v1/layouts?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": "layouts",
            "id": "{{uuid1}}",
            "attributes": {
                "name": "ném",
                "description": "deszkripsn",
                "createdAt": "2018-07-04T11:24:55.560+0000",
                "htmlContent": "<html>content</html>"
            }
        },
        {
            "type": "layouts",
            "id": "{{uuid2}}",
            "attributes": {
                "name": "ném2",
                "description": "deszkripsn2",
                "createdAt": "2018-07-04T11:52:16.404+0000",
                "htmlContent": "<html>content2</html>"
            }
        }
    ],
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create layout

Létrehoz egy új sablon keretet.

Web service API

Kérés

Név Típus Leírás Kötelező
layout WLayout1 Az új keret.
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 WLayout1 Az új keret.
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:createLayout>
         <request>
            <clientHashKey>?</clientHashKey>
            <layout>
               <description>probaxx</description>
               <htmlContent>bemuatoxx</htmlContent>
               <id>11233211</id>
               <name>palindrom idxx</name>
            </layout>
         </request>
      </tem:createLayout>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createLayoutResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <layout>
               <description>probaxx</description>
               <htmlContent>bemuatoxx</htmlContent>
               <id>129</id>
               <name>palindrom idxx</name>
            </layout>
         </response>
      </ns2:createLayoutResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/template/v1/layouts

body: JLayout1

Válasz

Típus Leírás
JLayout1 A létrehozott keret.

Minta

POST /hammy/json/template/v1/layouts?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
    "id" : "31de152d-7ded-4faa-8aef-58ada830e524",
    "type" : "layouts",
    "attributes" : {
        "name" : "Layout név",
        "description" : "Layout leírás",
        "htmlContent" : "<html>content2</html>"
    }
  }
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "layouts",
        "id": "31de152d-7ded-4faa-8aef-58ada830e524",
        "attributes": {
            "name": "Layout név",
            "description": "Layout leírás",
            "htmlContent": "<html>content2</html>"
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update layout

Módosít egy sablon keretet.

Web service API

Kérés

Név Típus Leírás Kötelező
layout WLayout1 A módosított keret.
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 WLayout1 A módosított keret.
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://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:updateLayout>
         <request>
            <clientHashKey>?</clientHashKey>
            <layout>
               <description>teszt</description>
               <htmlContent>teszt</htmlContent>
               <id>139</id>
            </layout>
         </request>
      </tem:updateLayout>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:updateLayoutResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <layout>
               <createdAt>2019-04-18T12:23:50.620+02:00</createdAt>
               <description>teszt</description>
               <htmlContent>teszt</htmlContent>
               <id>139</id>
               <name>teszt</name>
            </layout>
         </response>
      </ns2:updateLayoutResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/template/v1/layouts

body: JLayout1

Válasz

Típus Leírás
JLayout1 A létrehozott keret.

Minta

PUT /hammy/json/template/v1/layouts?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "layouts",
        "id": "31de152d-7ded-4faa-8aef-58ada830e524",
        "attributes": {
            "name": "Layout név",
            "description": "Módosított layout leírás",
            "htmlContent": "<html>Moódosított content</html>"
        }
    }
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "layouts",
        "id": "31de152d-7ded-4faa-8aef-58ada830e524",
        "attributes": {
            "name": "Layout név",
            "description": "Módosított layout leírás",
            "createdAt": "2018-07-12T09:17:29.698+0000",
            "htmlContent": "<html>Moódosított content</html>"
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

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ő
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 WTemplateHandlingCategory1 [ ] 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:listTemplateHandlingCategories>
         <request>
            <clientHashKey>?</clientHashKey>
         </request>
      </tem:listTemplateHandlingCategories>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listTemplateHandlingCategoriesResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <templateHandlingCategoryList>
               <templateHandlingCategory>
                  <categoryName>Strict Error Category 3</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>41</id>
                     <name>Normal 2</name>
                     <punishmentMins>10</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>62</id>
                  <renderMarkdown>true</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>62</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Supervisor Category</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>21</id>
                  <renderMarkdown>false</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>21</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Strict Error Category 2</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>61</id>
                  <renderMarkdown>true</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>61</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <assetDeliveryMode>inline</assetDeliveryMode>
                  <categoryName>Default Category with text and logo</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>81</id>
                  <renderMarkdown>false</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>81</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <assetDeliveryMode>inline</assetDeliveryMode>
                  <categoryName>EDM_CAT</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>csaba@dbx.hu</responsibles>
                  </erHandlingCategory>
                  <id>41</id>
                  <renderMarkdown>false</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>41</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Normal Rendering</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>4</id>
                  <renderMarkdown>false</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>4</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Layout Rendering with Markdown</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>3</id>
                  <renderMarkdown>true</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>3</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Strict Error Category</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>2</id>
                  <renderMarkdown>false</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>2</uuid>
               </templateHandlingCategory>
               <templateHandlingCategory>
                  <categoryName>Default Error Category</categoryName>
                  <erHandlingCategory>
                     <failureLimitPerMin>10</failureLimitPerMin>
                     <id>21</id>
                     <name>Normal</name>
                     <punishmentMins>60</punishmentMins>
                     <responsibles>teszt@elek.hu</responsibles>
                  </erHandlingCategory>
                  <id>1</id>
                  <renderMarkdown>true</renderMarkdown>
                  <replaceLinks>false</replaceLinks>
                  <uuid>1</uuid>
               </templateHandlingCategory>
            </templateHandlingCategoryList>
         </response>
      </ns2:listTemplateHandlingCategoriesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/templateHandlingCategories

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/v1/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": []
        }
    }
}

Export templates

Sablonok exportálása a rendszerből.

Web service API

Kérés

GET hammy/json/template/v1/exportTemplates

Paraméter 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 WExportMessage1 [ ] 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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:exportTemplates>
         <request>
            <clientHashKey>221d316146c591897238</clientHashKey>
            <templateNameList>
               <templateName>TP</templateName>
            </templateNameList>
         </request>
      </tem:exportTemplates>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:exportTemplatesResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <exportMessageList>
               <exportMessage>
                  <assetList/>
                  <cgParamList/>
                  <customData><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
                    <listTemplateParamResp>
                        <categoryList/>
                        <customXml></customXml>
                        <documents>
                            <document>
                                <filename>${fileName}</filename>
                            </document>
                        </documents>
                        <templateDynamicParamList/>
                        <templateName>TP</templateName>
                    </listTemplateParamResp>]]>
                   </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>
         </response>
      </ns2:exportTemplatesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/template/v1/exportTemplates

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 WExportMessage1 [ ] Exportált sablonok.
filePath String Jelenleg nincs használva.

Minta

GET /hammy/json/template/v1/exportTemplates?templateNameList%5B%5D=TP
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
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            <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 WExportMessage1 [ ] 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

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:tem="http://template.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:importTemplates>
         <!--Optional:-->
         <request>
            <clientHashKey>221d316146c591897238</clientHashKey>
           <exportMessageList>
               <exportMessage>
                  <assetList/>
                  <cgParamList/>
                  <customData><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
                    <listTemplateParamResp>
                        <categoryList/>
                        <customXml></customXml>
                        <documents>
                        </documents>
                        <templateDynamicParamList/>
                        <templateName>TP</templateName>
                    </listTemplateParamResp>]]>
                  </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>
         </request>
      </tem:importTemplates>
   </soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:importTemplatesResponse xmlns:ns2="http://template.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
         </response>
      </ns2:importTemplatesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/template/v1/importTemplates

multipart kérés.

Multipart név Típus Leírás
import_data WExportMessage1 [ ] Az importálandó sablonok.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.

Minta

PUT /hammy/json/template/v1/importTemplates
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: multipart/form-data
import_data={{path}}{{fileName}}
{
    "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" : [ ]
  }
}