Recipient API V1

HammyRecipient1API WSDL letöltése

Find recipients

Címzettek keresése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipients

Paraméter	Típus	Leírás
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.
recipientGroupId	String	Címlista azonosítója.
emailAddress	String	Címzett email címe.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/recipients/{{recipientUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

GET /hammy/json/recipient/v1/recipients/d444f216-92a2-41b7-be44-234c580636c5

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "recipients",
    "id": "d444f216-92a2-41b7-be44-234c580636c5",
    "attributes": {
      "emailAddress": "csaba2@dbx.hu"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show recipient

Címzett lekérése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipients/{{uuid}}

Válasz

Típus	Leírás
JRecipient1	A keresett címzett.

Minta

Create recipient

Címzett létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipients

body: JRecipient1

Válasz

Típus	Leírás
JRecipient1	A létrehozott címzett.

Minta

KérésVálasz

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

{
    "data": {
        "type": "recipients",
        "id": "324d748f-731b-43c2-b125-aeacf57fccc6",
        "attributes": {
            "emailAddress": "active@lovas.hu"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipients",
        "id": "324d748f-731b-43c2-b125-aeacf57fccc6",
        "attributes": {
            "emailAddress": "active@lovas.hu",
            "status": "ACTIVE"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update recipient

Címzett módosítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

PUT hammy/json/recipient/v1/recipients/{{uuid}}

body: JRecipient1

path

Név	Típus	Leírás
uuid	String	A módosítandó címzett UUID-ja.

Válasz

Típus	Leírás
JRecipient1	A módosított címzett.

Minta

KérésVálasz

PUT /hammy/json/recipient/v1/recipients/{{recipientUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipients",
        "id": "324d748f-731b-43c2-b125-aeacf57fccc6",
        "attributes": {
            "emailAddress": "active@lovas.hu"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipients",
        "id": "324d748f-731b-43c2-b125-aeacf57fccc6",
        "attributes": {
            "emailAddress": "active@lovas.hu",
            "status": "ACTIVE"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete recipient

Címzett törlése. Logikai törlést hajt végre, deleted_at DB mezőt a törlés dátumával tölti ki.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

DELETE hammy/json/recipient/v1/recipients/{{uuid}}

path

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

Válasz

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

Minta

KérésVálasz

DELETE /hammy/json/recipient/v1/recipients/{{recipientUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "emptyResponse",
    "id": "72196470-9687-4af0-9b9e-8e7a43ba3b61",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Find recipient groups

Címlisták keresése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientGroups

Paraméter	Típus	Leírás
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.
name	String	Címlista neve.
newsLetter	Boolean	Hírlevél-e.
createdBy	String	A címlistát létrehozó felhasználó neve.
sourceType	String	Címlista forrásának típusa: csv_upload, csv_file, jdbc.
statuses	String [ ]	Címlista státuszai: ACTIVE, FAVORITE, ARCHIVED, DEPRECATED, DELETED.
createdAtFrom	Date	Létrehozása dátuma, alsó határ.
createdAtTo	Date	Létrehozása dátuma, felső határ.
includeDeleted	Boolean	Törölt elemek mutatása.
includeDeprecated	Boolean	Deprecated elemek mutatása (3.21.6 DDM refactor előtt hozták létre).

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/recipientGroups
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

Query params:
-------------------------
name={{név, bárhol keres a címlista nevében}}
newsLetter={{true|false|null}}
createdBy={{userName}}
createdAtFrom={{YYYY-MM-DD}}
createdAtTo={{YYYY-MM-DD}}
sourceType={{lásd. RecipientGroup entitás definíció}}
statuses={[]} - default értékei ACTIVE, ONESHOT
includeDeleted={{true|false|null}} - default értéke false
includeDeprecated={{true|false|null}} - default értéke true

limit={{}}
offset={{}}

/hammy/json/recipient/v1/recipientGroups?name=teszt&createdAtFrom=2020-04-01&createdAtTo=2021-01-01&sourceType=csv_upload&statuses%5B%5D=DELETED&statuses%5B%5D=ARCHIVED

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "recipientGroups",
      "id": "3ed79646-e66f-4398-81d6-7002d24266f3",
      "attributes": {
        "name": "teszt lista",
        "sourceType": "csv_upload",
        "createdAt": "2020-05-28T12:49:58.962+0200"
      }
    }
  ],
  "meta": {
    "total": 1,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show recipient group

Címlista lekérése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientGroups/{{uuid}}

Válasz

Típus	Leírás
JRecipientGroup1	A kért lista.

Minta

KérésVálasz

GET /hammy/json/recipient/v1/recipientGroups/{{groupUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

GET /hammy/json/recipient/v1/recipientGroups/213fbee1-1ee5-4428-a437-b206b0485fd7

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "recipientGroups",
    "id": "213fbee1-1ee5-4428-a437-b206b0485fd7",
    "attributes": {
      "name": "tesztcímlista 0225",
      "description": "xxxxx",
      "sourceType": "jdbc",
      "sourceName": "cimzettek_tabla"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create recipient group

Címlista létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipientGroups

body: JRecipientGroup1

Válasz

Típus	Leírás
JRecipientGroup1	A létrehozott lista.

Minta

KérésVálasz

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

{
    "data": {
        "type": "recipientGroups",
        "attributes": {
            "name": "tesztcímlista 0225",
            "description": "xxxxx",
            "sourceType": "jdbc",
            "sourceName": "cimzettek_tabla"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipientGroups",
        "id": "213fbee1-1ee5-4428-a437-b206b0485fd7",
        "attributes": {
            "name": "tesztcímlista 0225",
            "description": "xxxxx",
            "sourceType": "jdbc",
            "sourceName": "cimzettek_tabla"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update recipient group

Címlista módosítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

PUT hammy/json/recipient/v1/recipientGroups/{{uuid}}

body: JRecipientGroup1

path

Név	Típus	Leírás
uuid	String	A módosítandó lista UUID-ja.

Válasz

Típus	Leírás
JRecipientGroup1	A módosított lista.

Minta

KérésVálasz

PUT /hammy/json/recipient/v1/recipientGroups/{{groupUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipientGroups",
        "attributes": {
            "name": "tesztcímlista 0225",
            "description": "xxxxx",
            "sourceType": "jdbc",
            "sourceName": "cimzettek_tabla"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "recipientGroups",
        "id": "213fbee1-1ee5-4428-a437-b206b0485fd7",
        "attributes": {
            "name": "tesztcímlista 0225",
            "description": "xxxxx",
            "sourceType": "jdbc",
            "sourceName": "cimzettek_tabla"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete recipient group

Címlista törlése. Logikai törlés történik, azaz fizikailag nem töröljük ki az adatbázisból, hanem deletedAt mezőt és státuszt állítjuk.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	Címlista azonosító.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

DELETE hammy/json/recipient/v1/recipientGroups/{{uuid}}

path

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

Válasz

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

Minta

KérésVálasz

DELETE /hammy/json/recipient/v1/recipientGroups/{{groupUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

DELETE /hammy/json/recipient/v1/recipientGroups/213fbee1-1ee5-4428-a437-b206b0485fd7

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Find members

Címlista tagjainak keresése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientGroups/{recipientGroupUuid}/members

POST hammy/json/recipient/v1/recipientGroups/members

GET esetén query paraméterként lehet megadni a mezőket, POST esetén a body-ban.

path

Név	Típus	Leírás
uuid	String	Az adott címlista UUID-ja.

Paraméter/Név	Típus	Leírás
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.
recipientGroupId	String	Címlista azonosítója.
emailAddress	String	A címzett email címe.
status	String	Címzett státusza. (ACTIVE, INVALID - email cím hibás)
unsubscribed	Boolean	Leiratkozott-e az adott címlistáról.
recipientUnsubscribed	Boolean	Globálisan leiratkozott-e
recipientUnsubscribedAtFrom	Date	Adott címlistáról leiratkozás időpontja, felső határ.
recipientUnsubscribedAtTo	Date	Adott címlistáról leiratkozás időpontja, alsó határ.
unsubscribedAtFrom	Date	Globális leiratkozás időpontja, felső határ.
unsubscribedAtTo	Date	Globális leiratkozás időpontja, alsó határ.
filters	JMemberAttributeFilter1 [ ]	Szűrési feltételek.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/recipientGroups/{{recipientGroupUuid}}/members
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

Query params:
-------------------------
emailAddress={{email cím, prefixre keres}}
status={{status kereső (ACTIVE|INVALID)}}
filters={{member attribútumra kereső elemek, key, operator, value/values}} operator értékei: EQ, IN, LIKE, LE, LT, GE, GT
limit={{}}
offset={{}}
sort={{}} ha memberAttribute-ra szeretnénk rendezni: attributeList[ATTR_KEY] formában kell beküldeni. Pl. attributeList[BIRTHDATE]
recipientUnsubscribedAtFrom={{globális leiratkozás kezdő dátum}}
recipientUnsubscribedAtTo={{globális leiratkozás végső dátum}}
unsubscribedAtFrom={{címlista leiratkozás kezdő dátum}}
unsubscribedAtTo={{címlista leiratkozás végső dátum}}

GET /hammy/json/recipient/v1/recipientGroups/{{recipientGroupUuid}}/members?filters%5B0%5D%5Bkey%5D=AGE&filters%5B0%5D%5Bvalue%5D=25&filters%5B0%5D%5Boperator%5D=GT&sort=emailAddress,-attributeList%5BBIRTHDATE%5D

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "members",
      "id": "55879ec2-44f2-4ab8-8f27-00375d9caafc",
      "attributes": {
        "emailAddress": "csaba3@dbx.hu",
        "recipientStatus": "ACTIVE",
        "attributeList": [
          {
            "key": "AGE",
            "value": 96
          },
          {
            "key": "MOBILE",
            "value": "06301234567"
          },
          {
            "key": "NAME",
            "value": "Teszt Elek 3"
          }
        ]
      }
    },
    {
      "type": "members",
      "id": "7a3d5306-709f-4bf7-a453-9ef52e2b59c3",
      "attributes": {
        "emailAddress": "kishari@gmail.com",
        "recipientStatus": "ACTIVE",
        "attributeList": [
          {
            "key": "AGE",
            "value": 35
          },
          {
            "key": "MOBILE",
            "value": "06301234567"
          },
          {
            "key": "NAME",
            "value": "Kis Hari"
          }
        ]
      }
    }
  ],
  "meta": {
    "total": 2,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create member

Címlista tag létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/members

body: JMember1

Válasz

Típus	Leírás
JMember1	A létrehozott tag.

Minta

KérésVálasz

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

{
    "data": {
        "type": "members",
        "id": "37cbf77a-b3a5-40f4-ba51-b643e3ff6e4f",
        "attributes": {
            "recipientGroupId": "e320cbc0-d59d-43af-a2d7-d94cfec32d2e",
            "recipientId": "d1066473-ef98-4487-be97-8a83b04bcfaa",
            "attributeList": [
                {"key": "recipientName","value": "lovas géza2"},
                {"key": "birthDate","value": "1986-01-01T10:15:53.649+0200"}]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "members",
        "id": "37cbf77a-b3a5-40f4-ba51-b643e3ff6e4f",
        "attributes": {
            "recipientGroupId": "e320cbc0-d59d-43af-a2d7-d94cfec32d2e",
            "recipientId": "d1066473-ef98-4487-be97-8a83b04bcfaa",
            "emailAddress": "csaba.harangozo@hammy.hu",
            "attributeList": [
                {
                    "key": "recipientName",
                    "value": "lovas géza"
                },
                {
                    "key": "birthDate",
                    "value": "1986-01-01T09:15:53.649+0100"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update member

Címlista tag módosítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

PUT hammy/json/recipient/v1/members/{{uuid}}

body: JMember1

path

Név	Típus	Leírás
uuid	String	A módosítandó tag UUID-ja.

Válasz

Típus	Leírás
JMember1	A módosított tag.

Minta

KérésVálasz

PUT /hammy/json/recipient/v1/members/{{memberUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "members",
        "id": "37cbf77a-b3a5-40f4-ba51-b643e3ff6e4f",
        "attributes": {
            "recipientGroupId": "e320cbc0-d59d-43af-a2d7-d94cfec32d2e",
            "recipientId": "d1066473-ef98-4487-be97-8a83b04bcfaa",
            "attributeList": [
                {"key": "recipientName","value": "lovas géza2"},
                {"key": "birthDate","value": "1986-01-01T10:15:53.649+0200"}]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "members",
        "id": "37cbf77a-b3a5-40f4-ba51-b643e3ff6e4f",
        "attributes": {
            "recipientGroupId": "e320cbc0-d59d-43af-a2d7-d94cfec32d2e",
            "recipientId": "d1066473-ef98-4487-be97-8a83b04bcfaa",
            "emailAddress": "csaba.harangozo@hammy.hu",
            "attributeList": [
                {
                    "key": "recipientName",
                    "value": "lovas géza"
                },
                {
                    "key": "birthDate",
                    "value": "1986-01-01T09:15:53.649+0100"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete member

Címlista tag törlése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

DELETE hammy/json/recipient/v1/members/{{uuid}}

path

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

Válasz

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

Minta

KérésVálasz

DELETE /hammy/json/recipient/v1/members/{{memberUuid}}
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": "72196470-9687-4af0-9b9e-8e7a43ba3b61",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete members

Címlista tagok tömeges törlése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipientGroups/{{recipientGroupUuid}}/deleteMembers

path

Név	Típus	Leírás
recipientGroupUuid	String	A címlista UUID-ja.

body

Név	Típus	Leírás
recipientGroupId	String	Címlista azonosító.
deleteType	String	Törlés típusa, lehetséges értékek: ALL - a címlista összes eleme, BY_ID_LIST - memberIdList elemei szerint, ALL_INVALID - összes INVALID státuszú tagot törli.
memberIdList	String [ ]	Címlista tag azonosítók. BY_ID_LIST esetén kötelező, egyéb esetben üres kell legyen.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/recipient/v1/recipientGroups/{{recipientGroupUuid}}/deleteMembers
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

POST /hammy/json/recipient/v1/recipientGroups/e320cbc0-d59d-43af-a2d7-d94cfec32d2e/deleteMembers

{
  "recipientGroupId": "e320cbc0-d59d-43af-a2d7-d94cfec32d2e",
  "deleteType": "BY_ID_LIST",
  "memberIdList": ["1ef04397-189f-407b-81c4-7fa7835553f8", "864571d9-f1b2-46c7-8c79-ac543e840474"]
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "emptyResponse",
    "id": "72196470-9687-4af0-9b9e-8e7a43ba3b61",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Synchronize recipients

Címzettek manuális szegmentálása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipientGroups/{{recipientGroupUuid}}/synchronizeRecipients

path

Név	Típus	Leírás
recipientGroupUuid	String	A címlista UUID-ja.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
jobId	String	A létrejött job azonosítója.

Minta

List recipients from source database

Címzettek listázása forrás adatbázisból.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientGroups/recipientsFromSourceDatabase

Paraméter	Típus	Leírás
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.
sourceType	String	Forrás típusa.
sourceName	String	Forrás neve.
sourceRef	String	Forrás referencia.
jobId	String	Job azonosítója.

Válasz

Minta

Upload recipients from file

Címzettek feltöltése csv fileból.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipients/import

multipart/form-data kérés.

Multipart név	Tartalom	Leírás
csvFile	application/octet-stream	A csv file tartalma.

Header	Típus	Leírás
X-Recipient-Group-Uuid	String	A címlista UUID-ja.
X-Recipient-Duplication-Handling-Type	String	Ismétlődő címzettek kezelési módja.
X-Csv-File-Encoding	String	A csv file kódolása.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
jobId	String	A létrejött job azonosítója.

Minta

KérésVálasz

POST /hammy/json/recipient/v1/recipients/import

Authorization: JWT {{jwtToken}}
Content-Type: multipart/form-data
X-User-Name: {{userName}}
X-Recipient-Group-Uuid: {{recipient group uuid}}
X-Csv-File-Encoding: {{csv file encoding}}

Form data:
-------------------------
csvFile={{címzetteket tartalmazó csv fájl}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "jobId": 256470
}

Upload unsubscribed recipients from file

Leiratkozottak feltöltése csv fileból.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipients/import/unsubscribe

multipart/form-data kérés.

Multipart név	Tartalom	Leírás
csvFile	application/octet-stream	A csv file tartalma.

Header	Típus	Leírás
X-Recipient-Group-Uuid	String	A címlista UUID-ja.
X-Csv-File-Encoding	String	A csv file kódolása.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
jobId	String	A létrejött job azonosítója.

Minta

Unsubscribe recipient

Címzett leiratkoztatása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
recipientEmailAddress	String	A tag email címe.
recipientGroupUuid	String	A címlista UUID-ja.
memberUuid	String	A tag UUID-ja.
changeReason	String	A státuszváltozás oka.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipients/unsubscribe

Név	Típus	Leírás
recipientEmailAddress	String	A tag email címe.
recipientGroupUuid	String	A címlista UUID-ja.
memberUuid	String	A tag UUID-ja.
changeReason	String	A státuszváltozás oka.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/recipient/v1/recipients/unsubscribe
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "recipientEmailAddress": "teszt@teszt.hu",
    "recipientGroupUuid": "c3bbdd9d-aea3-402d-b007-5d8e007cebdf"
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "emptyResponse",
        "id": "c6315901-06b4-4a33-8fba-9ff2f1f096b0",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Resubscribe recipient

Leiratkozott címzett újrafeliratkoztatása.

Web service API

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
recipientEmailAddress	String	A tag email címe.
recipientGroupUuid	String	A címlista UUID-ja.
memberUuid	String	A tag UUID-ja.
changeReason	String	A státuszváltozás oka.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipients/resubscribe

Név	Típus	Leírás
recipientEmailAddress	String	A tag email címe.
recipientGroupUuid	String	A címlista UUID-ja.
memberUuid	String	A tag UUID-ja.
changeReason	String	A státuszváltozás oka.

Válasz

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

Minta

KérésVálasz

POST /hammy/json/recipient/v1/recipients/resubscribe
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "recipientEmailAddress": "teszt@teszt.hu",
    "recipientGroupUuid": "c3bbdd9d-aea3-402d-b007-5d8e007cebdf"
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "emptyResponse",
        "id": "c6315901-06b4-4a33-8fba-9ff2f1f096b0",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find recipient filters

Címzett szűrők keresése.

Web service API

Kérés

xml root: findRecipientFiltersRequest

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete.
uuid	String	A szűrő UUID-ja.
filterKind	String	A szűrő típusa: tiltó vagy engedélyező.
userName	String	A szűrt felhasználó.
domain	String	A szűrt szolgáltató.
organizationUuid	String	A szervezet UUID-ja.
filterLevel	String	Az érintett prioritási szint.
templateHandlingCategoryUuid	String	Levélsablon kategória UUID-ja.
messageType	String [ ]	Levélsablonok.
includeDeleted	Boolean	Törölt szűrők megjelenítése.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
total	Integer	Találatok száma.
recipientFilters	WRecipientFilter1 [ ]	A megtalált szűrők.

Minta

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientFilters

Paraméter	Típus	Leírás
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.
params	Param_V1 [ ]	Egyéb meta adatok.
id	String	A szűrő azonosítója.
filterKind	String	A szűrő típusa: tiltó vagy engedélyező.
userName	String	A szűrt felhasználó.
domain	String	A szűrt szolgáltató.
organizationUuid	String	A szervezet UUID-ja.
filterLevel	String	Az érintett prioritási szint.
templateHandlingCategoryUuid	String	Levélsablon kategória UUID-ja.
messageTypes	String [ ]	Levélsablonok.
includeDeleted	Boolean	Törölt szűrők megjelenítése.
createdBy	String	A szűrőt létrehozó felhasználó neve.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/recipientFilters
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

Query params:
-------------------------
filterKind={{DENY|ALLOW}}
filterLevel={{GENERAL|ORGANIZATION|TEMPLATE_HANDLING_CATEGORY|TEMPLATE}}
userName={{userName}}
domain={{domain}}
organizationUuid={{organizationUuid}}
templateHandlingCategoryUuid={{templateHandlingCategoryUuid}}
includeDeleted={{true|false|null}} - delfault értéke false
createdBy={{userName}}
messageTypes%5B%5D={{types}}

GET {{hammy-base}}/json/recipient/v1/recipientFilters?filterKind=deny&messageTypes%5B%5D=SMS_TESZT&filterLevel=template

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "recipientFilters",
      "id": "35bd79c0-2463-460e-ac6b-b4e1b7847da2",
      "attributes": {
        "createdAt": "2021-10-15T16:17:39.564+02:00",
        "updatedAt": "2021-10-15T16:17:39.564+02:00",
        "filterKind": "DENY",
        "filterLevel": "TEMPLATE",
        "userName": "tesztelek",
        "domain": "dbx.hu",
        "organizationUuid": "default",
        "templateHandlingCategoryUuid": "1",
        "messageType": "SMS_TESZT",
        "createdBy": "admin",
        "description": "hello"
      }
    }
  ],
  "meta": {
    "total": 1,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create recipient filter

Címzett szűrő létrehozása.

Web service API

Kérés

xml root: createRecipientFilterRequest

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
recipientFilter	WRecipientFilter1	A létrehozandó szűrő.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
recipientFilter	WRecipientFilter1	A létrehozott szűrő.

Minta

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipientFilters

body: JRecipientFilter1

Válasz

Típus	Leírás
JRecipientFilter1	A létrehozott szűrő.

Minta

KérésVálasz

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

{
  "data": {
    "type": "recipientFilters",
    "attributes": {
      "userName": "tesztelek",
      "domain": "dbx.hu",
      "filterLevel": "TEMPLATE",
      "filterKind": "DENY",
      "messageType": "SMS_Teszt",
      "description": "hello"
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "recipientFilters",
    "id": "35bd79c0-2463-460e-ac6b-b4e1b7847da2",
    "attributes": {
      "createdAt": "2021-10-15T16:17:39.564+02:00",
      "updatedAt": "2021-10-15T16:17:39.564+02:00",
      "filterKind": "DENY",
      "filterLevel": "TEMPLATE",
      "userName": "tesztelek",
      "domain": "dbx.hu",
      "organizationUuid": "default",
      "templateHandlingCategoryUuid": "1",
      "messageType": "SMS_TESZT",
      "createdBy": "admin",
      "description": "hello"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete recipient filter

Címzett szűrő törlése. Logikai törlés történik, azaz fizikailag nem töröljük ki a szűrőt az adatbázisból, hanem deletedAt mezőt és státuszt állítunk a szűrő entitáson. A törléshez a szűrő azonosítójának megadása szükséges.

Web service API

Kérés

xml root: deleteRecipientFilterRequest

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	A szűrő UUID-ja.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

DELETE hammy/json/recipient/v1/recipientFilters/{{uuid}}

path

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

Válasz

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

Minta

KérésVálasz

DELETE /hammy/json/recipient/v1/recipientFilters/{recipientFilterUuid}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

DELETE {{hammy-base}}/json/recipient/v1/recipientFilters/35bd79c0-2463-460e-ac6b-b4e1b7847da2

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "emptyResponse",
    "id": "d762fc09-f290-4614-83ed-d0d69a0b3629",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Upload recipient filters

Címzett szűrők feltöltése csv fileból.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/recipientFilters/upload

multipart/form-data kérés.

Multipart név	Tartalom	Leírás
csvFile	application/octet-stream	A csv file tartalma.

Multipart paraméter	Típus	Leírás
separator	String	A csv file elválasztó karaktere.

Header	Típus	Leírás
X-Csv-File-Encoding	String	A csv file kódolása.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
jobId	String	A létrejött job azonosítója.

Minta

KérésVálasz

POST /hammy/json/recipient/v1/recipientFilters/upload
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: multipart/form-data
X-Csv-File-Encoding: {{csv file encoding}}

Form data:
-------------------------
csvFile={{címzetteket tartalmazó csv fájl}}
separator={{csv fájl adat elválasztó karakter}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "meta": {
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    },
    "jobId": "fd51ff4d-2f19-4b1f-b5cc-b936d98c2417"
}

Find applied recipient filters

Adott email címhez tartozó szűrők lekérdezése.

Web service API

Kérés

xml root: findAppliedRecipientFiltersRequest

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	A címzett email címe.
messageType	String	A sablon típusa.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
total	Integer	Találatok száma.
recipientFilters	WRecipientFilter1 [ ]	A megtalált szűrők.

Minta

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/recipientFilters/applied

Paraméter	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.
emailAddress	String	A címzett email címe.
messageType	String	A sablon típusa.

Válasz

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

Minta

KérésVálasz

GET {{hammy-base}}/json/recipient/v1/recipientFilters/applied
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

Query params:
-------------------------
emailAddress={emailAddress}

GET {{hammy-base}}/json/recipient/v1/recipientFilters/applied?emailAddress=teszt@dbx.hu

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [],
  "meta": {
    "total": 0,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

List member attribute codes

Címzett attribútum kódok listázása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/memberAttributeCodes

Paraméter	Típus	Leírás
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/memberAttributeCodes
X-User-Name: {{userName}}
Content-Type: application/json

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "memberAttributeCodes",
      "id": "e73951b9-1d8f-445d-afe0-6234a5ce433f",
      "attributes": {
        "code": "NAME",
        "label": "Név",
        "dataType": "STRING"
      }
    },
    {
      "type": "memberAttributeCodes",
      "id": "efa6283e-ecd1-4a8b-b8c4-806bd308abc7",
      "attributes": {
        "code": "MOBILE",
        "label": "Mobil",
        "dataType": "STRING"
      }
    },
    {
      "type": "memberAttributeCodes",
      "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
      "attributes": {
        "code": "TELEFON",
        "label": "Vonalas telefon",
        "dataType": "STRING"
      }
    },
    {
      "type": "memberAttributeCodes",
      "id": "56a88db4-c72f-4f9e-a898-3d469fd4e27b",
      "attributes": {
        "code": "PLATE_NUMBER",
        "label": "Rendszám xx",
        "dataType": "STRING"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show member attribute code

Címzett attribútum kód lekérése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/memberAttributeCodes/{{uuid}}

Válasz

Típus	Leírás
JMemberAttributeCode1	A keresett kód.

Minta

KérésVálasz

GET /hammy/json/recipient/v1/memberAttributeCodes/{{attrCodeUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

GET /hammy/json/recipient/v1/memberAttributeCodes/4a7ff867-4a2f-465b-b736-4786c2be5859

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "memberAttributeCodes",
    "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
    "attributes": {
      "code": "TELEFON",
      "label": "Vonalas telefon",
      "dataType": "STRING"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create member attribute code

Címzett attribútum kód létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/memberAttributeCodes

body: JMemberAttributeCode1

Válasz

Típus	Leírás
JMemberAttributeCode1	A létrehozott kód.

Minta

KérésVálasz

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

{
    "data": {
        "type": "memberAttributeCodes",
        "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
        "attributes": {
            "code": "TELEFON",
            "label": "Vonalas telefon",
            "dataType": "STRING"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "memberAttributeCodes",
        "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
        "attributes": {
            "code": "TELEFON",
            "label": "Vonalas telefon",
            "dataType": "STRING"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update member attribute code

Címzett attribútum kód módosítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

PUT hammy/json/recipient/v1/memberAttributeCodes/{{uuid}}

body: JMemberAttributeCode1

path

Név	Típus	Leírás
uuid	String	A módosítandó kód UUID-ja.

Válasz

Típus	Leírás
JMemberAttributeCode1	A módosított kód.

Minta

KérésVálasz

PUT /hammy/json/recipient/v1/memberAttributeCodes/{{attrCodeUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "memberAttributeCodes",
        "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
        "attributes": {
            "code": "TELEFON",
            "label": "Vonalas telefon",
            "dataType": "STRING"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "memberAttributeCodes",
        "id": "4a7ff867-4a2f-465b-b736-4786c2be5859",
        "attributes": {
            "code": "TELEFON",
            "label": "Vonalas telefon",
            "dataType": "STRING"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete member attribute code

Címzett attribútum kód törlése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

DELETE hammy/json/recipient/v1/memberAttributeCodes/{{uuid}}

path

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

Válasz

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

Minta

Manage member attribute defs

Címlista tagok attribútum definícióinak kezelése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/recipient/v1/manageMemberAttributeDefs

Név	Típus	Leírás
memberAttributeDefs	JMemberAttributeDef1 [ ]	Definíciók listája.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JMemberAttributeDef1 [ ]	A módosított definíciók.

Minta

KérésVálasz

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

{
  "memberAttributeDefs": [
  {
    "uuid": "65f8cbab-3e2c-404c-9c23-7068520bbd9b",
    "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
    "key": "MOBILE",
    "originalKey": "mobil_telefon",
    "searchable": true
  },
  {
    "uuid": "4092edad-3eba-4671-b750-d27adb3a2083",
    "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
    "key": "NAME",
    "originalKey": "neve",
    "searchable": true
  }]
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "list": [
    {
      "uuid": "65f8cbab-3e2c-404c-9c23-7068520bbd9b",
      "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
      "key": "MOBILE",
      "originalKey": "mobil_telefon",
      "searchable": true
    },
    {
      "uuid": "4092edad-3eba-4671-b750-d27adb3a2083",
      "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
      "key": "NAME",
      "originalKey": "neve",
      "searchable": true
    }
  ]
}

Find member attribute defs

Címlista tagok attribútum definícióinak lekérdezése.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1/memberAttributeDefs

Név	Típus	Leírás
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.
recipientGroupUuid	String	Címlista UUID.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/recipient/v1/memberAttributeDefs
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

Query params:
-------------------------
recipientGroupUuid={{címlista azonosító}}

GET /hammy/json/recipient/v1/memberAttributeDefs?recipientGroupUuid=7469c71b-57cb-46f9-a536-8c87e7ab6065

HTTP/1.1 200 OK
Content-Type: application/json

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "list": [
    {
      "uuid": "65f8cbab-3e2c-404c-9c23-7068520bbd9b",
      "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
      "key": "MOBILE",
      "originalKey": "mobil_telefon",
      "searchable": true
    },
    {
      "uuid": "4092edad-3eba-4671-b750-d27adb3a2083",
      "recipientGroupId": "7469c71b-57cb-46f9-a536-8c87e7ab6065",
      "key": "NAME",
      "originalKey": "neve",
      "searchable": true
    }
  ]
}

Fill recipients statuses

Címzettek státuszának beállítása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/recipient/v1//recipients/fillStatuses

Paraméter	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.

Válasz

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

Minta