Life Course API V2 (REST)

REST API

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

Find life courses

Életutak keresése.

REST API

REST API Info

Kérés

GET hammy/json/lifeCourse/v2/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	JLifeCourse2 [ ]	A megtalált életutak.

Minta

KérésVálasz

GET {{baseUrl}}/json/lifeCourse/v2/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": "1000000098",
            "attributes": {
                "batchPackageExtId": "1000000098",
                "name": "0000SZAMLAL",
                "totalRequests": 100,
                "successRequests": 100,
                "errorRequests": 0,
                "createdAt": "2019-07-24T07:41:26.327+0200",
                "enabledAt": "2019-07-24T07:42:06.302+0200",
                "status": "DELETED",
                "statusReason": "kutya",
                "lightDeletionStatus": "IN_PROGRESS",
                "batches": [
                    {
                        "batchNumber": 1,
                        "batchExtId": "9911",
                        "letterType": "LETTER_TYPE_"
                    }
                ],
                "counters": [
                    {
                        "channel": "EMAIL",
                        "total": 50,
                        "error": 2,
                        "success": 48
                    },
                    {
                        "channel": "ARCHIVE",
                        "total": 25,
                        "error": 4,
                        "success": 21
                    },
                    {
                        "channel": "POST",
                        "total": 25,
                        "error": 0,
                        "success": 25
                    }
                ]
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create life course

Életút létrehozása.

REST API

REST API Info

Kérés

POST hammy/json/lifeCourse/v2/lifeCourses

body: JLifeCourse_V1

Válasz

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

Minta

KérésVálasz

POST {{baseUrl}}/json/lifeCourse/v2/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.

REST API

REST API Info

Kérés

PUT hammy/json/lifeCourse/v2/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
JLifeCourse2	A módosított életút.

Minta

KérésVálasz

PUT {{baseUrl}}/json/lifeCourse/v2/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

Ebben a verzióban nem változott.

Statistics V1