Message API V1

Lock messages

Üzenetek zárolása/zárolás feloldása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
action	String	Művelet: `LOCK`, `UNLOCK`.
messageUuidList	String [ ]	A módosítandó üzenetek 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

POST hammy/json/message/v1/lockMessages

Név	Típus	Leírás
action	String	Művelet: `LOCK`, `UNLOCK`.
messageUuidList	String [ ]	A módosítandó üzenetek UUID-ja.

Válasz

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

Minta

KérésVálasz

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

{
"action": "LOCK|UNLOCK",
"messageUuidList": ["534a64ee-3dfe-4216-8803-ae8e4aacb896", "b718c005-5142-40a6-9f03-8d28c199b743"]
}

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

{
  "data": {
    "type": "emptyResponse",
    "id": "8a1da4ca-ba69-47d6-8771-e017e22c54ba",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete messages

Üzenetek logikai törlése (deleted_at mező töltése).

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
messageUuidList	String [ ]	A törlendő üzenetek UUID-ja.
messageIdList	Integer [ ]	A törlendő üzenetek ID-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

POST hammy/json/message/v1/deleteMessages

Név	Típus	Leírás
messageUuidList	String [ ]	A törlendő üzenetek UUID-ja.
messageIdList	Integer [ ]	A törlendő üzenetek ID-ja.

Válasz

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

Minta

KérésVálasz

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

{
  "messageUuidList": ["6c1aa418-0a6c-4520-8bb0-d4344d1305ee", "2cc8e3e1-efaf-484d-b810-314dc2b2e6d4"],
  "messageIdList": [1, 2, 3]
}

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

{
  "data": {
    "type": "emptyResponse",
    "id": "8a1da4ca-ba69-47d6-8771-e017e22c54ba",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Recover messages

Üzenetek logikai törlésének megszűntetése (deleted_at mező törlése).

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
messageUuidList	String [ ]	A visszaállítandó üzenetek UUID-ja.
messageIdList	Integer [ ]	A visszaállítandó üzenetek ID-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

POST hammy/json/message/v1/recoverMessages

Név	Típus	Leírás
messageUuidList	String [ ]	A visszaállítandó üzenetek UUID-ja.
messageIdList	Integer [ ]	A visszaállítandó üzenetek ID-ja.

Válasz

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

Minta

KérésVálasz

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

{
  "messageUuidList": ["6c1aa418-0a6c-4520-8bb0-d4344d1305ee", "2cc8e3e1-efaf-484d-b810-314dc2b2e6d4"],
  "messageIdList": [1, 2, 3]
}

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

{
  "data": {
    "type": "emptyResponse",
    "id": "8a1da4ca-ba69-47d6-8771-e017e22c54ba",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Count messages

Időszakra számolt üzenetek és generált dokumentumok száma.

REST API

REST API Info

Kérés

GET hammy/json/message/v1/countMessages

A kérésben a fromDate és a toDate "timestamp" típusú paraméterekkel adható meg a lekérdezés kezdő és végdátuma.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
id	String	vnd.api ID
numberOfMessages	Long	Időszakra eső üzenetek száma.
numberOfDocuments	Long	Időszakra eső generált száma.
fromDate	Date	Időszakra kezdete.
toDate	Date	Időszakra vége.

Minta

KérésVálasz

GET /hammy/json/message/v1/countMessages?fromDate=2024-05-01T12%3A00%3A00%2B02%3A00
Authorization: JWT {{jwtToken}}
Content-Type: application/json
Accept: application/json

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

{
  "data": {
    "type": "countMessagesResults",
    "id": "b15bcca4-0f07-4baa-83f2-8081883bdade",
    "attributes": {
      "numberOfMessages": 281,
      "numberOfDocuments": 4,
      "fromDate": "2024-05-01T12:00:00.000+02:00",
      "toDate": "2024-08-29T15:13:47.435+02:00"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}