Return mail task API V1

Get reply

Egy adott válasz lekérése.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
replyId	Integer	A válasz entitás azonosító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.
replyMessage	WReplyMessage1	A kért válasz.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.groupama.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:getReply>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                </requestMeta>
                <replyId>1</replyId>
            </request>
        </ser:getReply>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <S:Body xmlns:ns2="http://service.groupama.hammy.dbx.hu/">
        <ns2:getReplyResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <replyMessage>
                <createdAt>2019-01-22T11:02:04.195+01:00</createdAt>
                <fromAddress>example.address@example.com</fromAddress>
                <id>1</id>
                <replyDump>...</replyDump>
                <replySource>example@example.com</replySource>
                <replyStatus>UNIDENTIFIED</replyStatus>
                <replyType>REPLY_MAIL</replyType>
                </replyMessage>
            </response>
        </ns2:getReplyResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/returnMailTask/v1/replies/{{replyId}}

Válasz

Típus	Leírás
JReply1	A kért válasz.

Minta

KérésVálasz

GET /hammy/json/returnMailTask/v1/replies/{{replyMessage.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": "replies",
        "id": "{{replyMessage.id}}",
        "attributes": {
        "fromAddress": "no-reply@accounts.google.com",
        "replyStatus": "UNIDENTIFIED",
        "createdAt": "2019-01-22T11:03:03.781+0100",
        "replyType": "REPLY_MAIL",
        "replySource": "example.teszt@example.com"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
        "code": 0,
        "messages": []
        }
    }
}

List return mail task

Visszapattanó üzeneteket reprezentáló taszkok listázása, keresési szűrőfeltételekkel.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
originalTo	String	Az eredeti címzett (név, email).
originalFrom	String	Az eredeti feladó (név, email).
originalSender	String	Az eredeti küldő (név, email).
originalSubject	String	Az eredeti tárgy.
status	String	Státusz.
comment	String	Megjegyzés.
adUser	String	`ActiveDirectory` felhasználó.
senderApp	String	Az eredeti üzenet küldő alkalmazása.
replyStatus	String	A visszapattanás státusza.
replyStatusDesc	String	A visszapattanás státusz leírása.
createdFromDate	Date	Adott dátum után keletkezett entitások.
createdToDate	Date	Adott dátumig keletkezett entitások.
updatedFromDate	Date	Adott dátum után frissült entitások.
updatedToDate	Date	Adott dátumig frissült entitások.
updatedAt	Date	Entitás módosításának ideje.
limit	Integer	A találatok maximális száma.
offset	Integer	A találatok kezdete.

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.
returnMailTaskList	WReturnMailTask1 [ ]	A megtalált taszkok.
resultCount	Integer	A megtalált taszkok száma.
limit	Integer	A keresésnél használt limit.
offset	Integer	A keresésnél használt offset.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.groupama.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:listReturnMailTask>
            <request>
                <requestMeta>
                <clientHashKey>221d316146c591897238</clientHashKey>
                </requestMeta>
                <originalTo/>
                <originalFrom/>
                <originalSender/>
                <originalSubject/>
                <status>NEW</status>
                <comment/>
                <adUser/>
                <senderApp/>
                <replyStatus/>
                <replyStatusDesc/>
                <createdFromDate/>
                <createdToDate/>
                <updatedFromDate/>
                <updatedToDate/>
                <limit/>
                <offset/>
            </request>
        </ser:listReturnMailTask>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <S:Body xmlns:ns2="http://service.groupama.hammy.dbx.hu/">
        <ns2:listReturnMailTaskResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <returnMailTaskList>
                <returnMailTask>
                    <adUser>adUserJ2</adUser>
                    <comment>commentW</comment>
                    <createdAt>2018-12-19T13:26:37.240+01:00</createdAt>
                    <id>25354</id>
                    <originalFrom>Groupama Biztosító &lt;noreply@groupama.hu></originalFrom>
                    <originalHtml><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head>
                        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head> <body> <p><strong>Tisztelt Marton László!</strong></p><p>Ezúton küldjük Önnek a(z) ...</p>  </body></html>]]></originalHtml>
                    <originalSender>Groupama Biztosító&lt;hammyteszt.return@groupama.hu></originalSender>
                    <originalSubject>Értesítés dokumentum érkezéséről</originalSubject>
                    <originalTo>Marton László &lt;laszlo.marton@groupama.hu></originalTo>
                    <originalTxt><![CDATA[<p><strong>Tisztelt Marton László!</strong></p><p>Ezúton küldjük Önnek a(z) ...]]></originalTxt>
                    <replyId>1</replyId>
                    <replyStatus>NO_MAILBOX</replyStatus>
                    <replyStatusDesc>Nem létező postafiók!</replyStatusDesc>
                    <senderApp>hammy</senderApp>
                    <status>NEW</status>
                    <updatedAt>2019-11-27T12:06:57.621+01:00</updatedAt>
                </returnMailTask>
                </returnMailTaskList>
                <resultCount>1</resultCount>
            </response>
        </ns2:listReturnMailTaskResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/returnMailTask/v1/returnMailTasks

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.
originalTo	String	Az eredeti címzett (név, email).
originalFrom	String	Az eredeti feladó (név, email).
originalSender	String	Az eredeti küldő (név, email).
originalSubject	String	Az eredeti tárgy.
status	String	Státusz.
comment	String	Megjegyzés.
adUser	String	`ActiveDirectory` felhasználó.
senderApp	String	Az eredeti üzenet küldő alkalmazása.
replyStatus	String	A visszapattanás státusza.
replyStatusDesc	String	A visszapattanás státusz leírása.
createdFromDate	Date	Adott dátum után keletkezett entitások.
createdToDate	Date	Adott dátumig keletkezett entitások.
updatedFromDate	Date	Adott dátum után frissült entitások.
updatedToDate	Date	Adott dátumig frissült entitások.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/returnMailTask/v1/replies/returnMailTasks?status=NEW
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": "returnMailTasks",
            "id": "25354",
            "attributes": {
                "replyId": 1,
                "replyStatus": "NO_MAILBOX",
                "replyStatusDesc": "Nem létező postafiók!",
                "originalTo": "Marton László <laszlo.marton@groupama.hu>",
                "originalFrom": "Groupama Biztosító <noreply@groupama.hu>",
                "originalSender": "Groupama Biztosító\n\t<hammyteszt.return@groupama.hu>",
                "originalSubject": "Értesítés dokumentum érkezéséről",
                "originalTxt": "<p><strong>Tisztelt Marton László!</strong></p><p>Ezúton küldjük Önnek a(z) ...",
                "status": "NEW",
                "comment": "commentW",
                "adUser": "adUserJ2",
                "senderApp": "hammy",
                "createdAt": "2018-12-19T13:26:37.240+0100",
                "updatedAt": "2019-11-27T12:06:57.621+0100"
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
        "code": 0,
        "messages": []
        }
    }
}

Set return mail task

Entitások módosítására szolgál. Web service-n egyszerre több entitást is módosíthatunk, viszont REST/JSON API-n csak egyet.

Az üzleti logika helyes működése miatt, nem lehet egy entitás bármelyik tulajdonságát módosítani. Csak a következő tulajdonságok módosítása fog érvényre jutni:

status
comment
senderApp - A módosítás csak akkor kerül érvényre, ha van már értéke, és ez az érték nem hammy.
statusDesc
adUser

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
returnMailTaskList	WReturnMailTask1 [ ]	A módosításokat tartalmazó entitások listá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

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.groupama.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:setReturnMailTask>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                </requestMeta>
                <returnMailTaskList>
                <returnMailTask>
                    <adUser/>
                    <comment/>
                    <createdAt/>
                    <id>25354</id>
                    <originalFrom/>
                    <originalHtml/>
                    <originalSender/>
                    <originalSubject/>
                    <originalTo/>
                    <originalTxt/>
                    <replyId/>
                    <replyStatus/>
                    <replyStatusDesc/>
                    <senderApp/>
                    <status/>
                    <statusDesc>testWS3</statusDesc>
                    <updatedAt/>
                </returnMailTask>
                </returnMailTaskList>
            </request>
        </ser:setReturnMailTask>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <S:Body xmlns:ns2="http://service.groupama.hammy.dbx.hu/">
        <ns2:setReturnMailTaskResponse>
           <response>
              <status>
                 <code>0</code>
                 <messages/>
              </status>
           </response>
        </ns2:setReturnMailTaskResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/returnMailTask/v1/returnMailTasks/{{returnMailTaskId}}

body: JReturnMailTask1

Válasz

Típus	Leírás
JReturnMailTask1	A módosított taszk.

Minta

KérésVálasz

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

{
  "data": 
    {
      "type": "returnMailTasks",
      "id": {{returnMailTask.id}},
      "attributes": {
        "status": "NEW",
        "comment": "commentJ",
        "statusDesc": "statusDescJ2",
        "adUser": "adUserJ2"
      }
    }
}

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

{
    "data": {
        "type": "returnMailTasks",
        "id": {{returnMailTask.id}},
        "attributes": {
        "replyId": 2,
        "replyStatus": "NO_MAILBOX2",
        "replyStatusDesc": "Nem létező postafiók2",
        "originalTo": "Example To <to@example.com>",
        "originalFrom": "Example From <from@example.com>",
        "originalSender": "Example Sender <sender@example.com>",
        "originalSubject": "Orig subject",
        "originalTxt": "orig body",
        "originalHtml": "orig html body",
        "status": "NEW",
        "statusDesc": "statusDescJ2",
        "comment": "commentJ",
        "adUser": "adUserJ2",
        "senderApp": "hammy",
        "createdAt": "2019-11-22T11:11:00.000+0100",
        "updatedAt": "2019-12-03T09:10:23.015+0100"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
        "code": 0,
        "messages": []
        }
    }
}