Life Course API V1

HammyLifeCourse1API WSDL letöltése

Find life courses

Életutak keresése.

Web service API

Kérés

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.
name	String	Életút neve.
rootID	String	Root azonosító.
channel	String	Üzenet küldési csatorna.
letterType	String	Levél típusa.
createdAtFrom	Date	Létrehozás dátuma ettől.
createdAtTo	Date	Létrehozás dátuma eddig.
enabledAtFrom	Date	Engedélyezési dátum ettől.
enabledAtTo	Date	Engedélyezési dátum eddig.
statuses	String [ ]	[DEPRECATED] Státuszok.

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.
count	Integer	Találatok száma.
lifeCourse	WLifeCourse_V1 [ ]	Életutak.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.batch.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:findLifeCourses>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>X</userName>
                </requestMeta>
                <!--Optional:-->
                <limit>10</limit>
                <offset>0</offset>
                <!--<name>?</name>-->
                <!--<rootId>ROOT_ID_4</rootId>-->
                <!--<channel>?</channel>-->
                <!--<letterType>?</letterType>-->
                <!--<createdAtFrom>?</createdAtFrom>-->
                <!--<createdAtTo>?</createdAtTo>-->
                <!--<enabledAtFrom>?</enabledAtFrom>-->
                <!--<enabledAtTo>?</enabledAtTo>-->
                <statuses>NEW</statuses>
            </request>
        </ws:findLifeCourses>
    </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://ws.service.batch.api.hammy.dbx.hu/">
        <ns2:findLifeCoursesResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <lifeCourses>
                <batchPackageExtId>9910</batchPackageExtId>
                <name>null nyomtatvány megszemélyesítés, kiküldés</name>
                <totalRequests>11</totalRequests>
                <successRequests>11</successRequests>
                <errorRequests>0</errorRequests>
                <createdAt>2019-03-26T10:58:42.500+01:00</createdAt>
                <status>NEW</status>
                <rootId>ROOT_ID_4</rootId>
                <channel>EMAIL</channel>
                <batches>
                    <batchNumber>1</batchNumber>
                    <batchExtId>1</batchExtId>
                    <letterType>LETTER_TYPE_</letterType>
                </batches>
                </lifeCourses>
                <lifeCourses>
                <totalRequests>0</totalRequests>
                <successRequests>0</successRequests>
                <errorRequests>0</errorRequests>
                <createdAt>2019-03-07T10:56:23.139+01:00</createdAt>
                <status>NEW</status>
                <rootId>root</rootId>
                <batches>
                    <batchNumber>1</batchNumber>
                </batches>
                </lifeCourses>            
                <count>2</count>
            </response>
        </ns2:findLifeCoursesResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/lifeCourse/v1/lifeCourses

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	Életút neve.
id	String	Életút azonosító.
channel	String	Üzenet küldési csatorna.
letterType	String	Levél típusa.
createdAtFrom	Date	Létrehozás dátuma ettől.
createdAtTo	Date	Létrehozás dátuma eddig.
enabledAtFrom	Date	Engedélyezési dátum ettől.
enabledAtTo	Date	Engedélyezési dátum eddig.
statuses	String [ ]	[DEPRECATED] Státuszok.

Válasz

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

Minta

KérésVálasz

GET {{baseUrl}}/json/lifeCourse/v1/lifeCourses?id=ROOT_ID_2
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": "lifeCourses",
            "id": "ROOT_ID_2",
            "attributes": {
                "batchPackageExtId": "9910",
                "name": "PROCESS_NAME_",
                "totalRequests": 0,
                "successRequests": -7,
                "errorRequests": 7,
                "createdAt": "2019-02-08T09:05:17.967+0000",
                "status": "NEW",
                "channel": "DELIVERY_CHANNEL_",
                "batches": [
                    {
                        "batchNumber": 1,
                        "batchExtId": "9911",
                        "letterType": "LETTER_TYPE_"
                    }
                ]
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create life course

Életút létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
lifeCourse	WLifeCourse_V1	A létrehozandó életú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.
lifeCourse	WLifeCourse_V1	A létrehozott életút.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.batch.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:createLifeCourse>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>X</userName>
                </requestMeta>
                <lifeCourse>
                <batchPackageExtId>BPE_1</batchPackageExtId>
                <name>EXAMPLE_PROCESS_NAME</name>
                <totalRequests>6</totalRequests>
                <status>NEW</status>
                <rootId>EXAMPLE_ROOT_ID_3</rootId>
                <channel>EMAIL</channel>
                <batches>
                    <batchNumber>1</batchNumber>
                    <batchExtId>9912</batchExtId>
                    <letterType>LETTER_TYPE_</letterType>
                </batches>
                </lifeCourse>
            </request>
        </ws:createLifeCourse>
    </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://ws.service.batch.api.hammy.dbx.hu/">
        <ns2:createLifeCourseResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <lifeCourse>
                <batchPackageExtId>BPE_1</batchPackageExtId>
                <name>EXAMPLE_PROCESS_NAME</name>
                <totalRequests>6</totalRequests>
                <status>NEW</status>
                <rootId>EXAMPLE_ROOT_ID_3</rootId>
                <channel>EMAIL</channel>
                <batches>
                    <batchNumber>1</batchNumber>
                    <batchExtId>9912</batchExtId>
                    <letterType>LETTER_TYPE_</letterType>
                </batches>
                </lifeCourse>
            </response>
        </ns2:createLifeCourseResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/lifeCourse/v1/lifeCourses

body: JLifeCourse_V1

Válasz

Típus	Leírás
JLifeCourse_V1	A létrehozott életút.

Minta

KérésVálasz

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

{
    "data": {
            "type": "lifeCourses",
            "id": "LC_1",
            "attributes": {
                "status": "ENABLED",
                "batches": [
                    {
                        "batchNumber": 1
                    }
                ]
            }
    }
}

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

{
    "data": {
        "type": "lifeCourses",
        "id": "LC_1",
        "attributes": {
            "status": "ENABLED",
            "batches": [
                {
                    "batchNumber": 1
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update life course

Életút módosítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
lifeCourse	WLifeCourse_V1	A módosítandó életú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.
lifeCourse	WLifeCourse_V1	A módosított életút.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.batch.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:updateLifeCourse>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>X</userName>
                </requestMeta>
                <lifeCourse>
                <batchPackageExtId>BPE_1</batchPackageExtId>
                <name>EXAMPLE_PROCESS_NAME</name>
                <totalRequests>9</totalRequests>
                <status>FINISHED</status>
                <rootId>EXAMPLE_ROOT_ID_3</rootId>
                <channel>EMAIL</channel>
                <batches>
                    <batchNumber>1</batchNumber>
                    <batchExtId>9912</batchExtId>
                    <letterType>LETTER_TYPE_</letterType>
                </batches>
                </lifeCourse>
            </request>
        </ws:updateLifeCourse>
    </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://ws.service.batch.api.hammy.dbx.hu/">
        <ns2:updateLifeCourseResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <lifeCourse>
                <batchPackageExtId>BPE_1</batchPackageExtId>
                <name>EXAMPLE_PROCESS_NAME</name>
                <totalRequests>9</totalRequests>
                <status>FINISHED</status>
                <rootId>EXAMPLE_ROOT_ID_3</rootId>
                <channel>EMAIL</channel>
                <batches>
                    <batchNumber>1</batchNumber>
                    <batchExtId>9912</batchExtId>
                    <letterType>LETTER_TYPE_</letterType>
                </batches>
                </lifeCourse>
            </response>
        </ns2:updateLifeCourseResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/lifeCourse/v1/lifeCourses/{{rootId}}

body: JLifeCourse_V1

path

Név	Típus	Leírás
rootId	String	A módosítandó életút azonosítója.

Válasz

Típus	Leírás
JLifeCourse_V1	A módosított életút.

Minta

KérésVálasz

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

{
    "data": {
        "type": "lifeCourses",
        "id": "LC_1",
        "attributes": {
            "status": "DISABLED",
            "batches": [
                {
                    "batchNumber": 1
                }
            ]
        }
    }
}

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

{
    "data": {
        "type": "lifeCourses",
        "id": "LC_1",
        "attributes": {
            "status": "DISABLED",
            "batches": [
                {
                    "batchNumber": 1
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Statistics

Statisztikák életútról.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
rootId	String	Az életút 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.
cells	WLifeCourseStatisticsCell_V1 [ ]	Statisztikák.

Minta

REST API

REST API Info

Kérés

GET hammy/json/lifeCourse/v1/lifeCourses/{{rootId}}/statistics

path

Minta

KérésVálasz

GET: hammy/json/lifeCourse/v1/lifeCourses/{{rootId}}/statistics?limit=10&sort=10
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
    "meta": {
      "responseStatus": {
      "code": 0,
      "messages": []
      },
    "params": []
   },
      "data": {
      "ARCHIVE": {
        "N/A": {
        "ARCHIVED": 10000
       }
     }
  }
}

Kérés

PUT hammy/json/lifeCourse/v1/lifeCourses/{{rootId}}/statistics

path

Név	Típus	Leírás
rootId	String	Az életút azonosítója.

Paraméter	Típus	Leírás
rootId	String	Az életút azonosítója.
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

Minta