Public
Space shortcuts
Page tree

Versions Compared

Old Version 3

changes.mady.by.user Pal Somlyai

Saved on

compared with

New Version 4

changes.mady.by.user Pal Somlyai

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Elérési út/mailer/batch-recognize
Http műveletPOST
Kérés objektumBatchMailerAddressRecognitionRequest
Válasz objektumBatchMailerAddressRecognitionResponse
Lehetséges válaszkódok
  • 200: a címstrukturálás sikeresen megtörtént (De nem biztos, hogy minden címet sikerült bontani. Ez a válasz objektum megfelelő eleméből fog kiderülni.)
  • 400: hibás kérés, mely oka lehet:
    • Nem tudtuk deszerializálni a kérést (helytelen az átadott JSON). Ilyenkor nem kap vissza objektumot a válasz törzsében
    • A megszorításoknak nem megfelelő adatot adott meg. Ilyenkor a válasz objektum tartalmazza a validációs hibákat.
  • 401: sikertelen hitelesítés, mely oka lehet:
    • Hiányzik a hozzáférési token
    • Hibás a hozzáférési token (pl. helytelen a JWT token szignatúrája)
  • 403: hozzáférés megtagadva
  • 500: belső hiba lépett fel, kérjük ilyen esetben értesítse a Hibridlevél Kft. Ügyfélszolgálatát

Példa kérés


Code Blockcode
languagejs
titlePélda kérés
{
    "addressRecognitionRequests": [
        {
            "fullAddress": "This is an invalid address",
            "consignmentIdentifier": {
                "orderId": "1",
                "consignmentId": "1"
            },
            "serviceType": "NORMAL",
            "expectedPostDate": "2017-09-20"
        },
        {
            "fullAddress": "Dunaújváros Verebély u. 8 2400",
            "consignmentIdentifier": {
                "orderId": "1",
                "consignmentId": "2"
            },
            "serviceType": "NORMAL",
            "expectedPostDate": "2017-09-21"
        }
    ]
}


Code Block
languagejs
titlePélda válasz
{
    "addressRecognitionResults": [
        {
            "consignmentIdentifier": {
                "orderId": "1",
                "consignmentId": "1"
            },
            "structuredAddress": null,
            "probability": 0,
            "recognitionFailureReason": "INTERNAL_SERVER_ERROR",
            "successfullyRecognized": false
        },
        {
            "consignmentIdentifier": {
                "orderId": "1",
                "consignmentId": "2"
            },
            "structuredAddress": {
                "name": null,
                "city": "Dunaújváros",
                "street": {
                    "name": "Verebély",
                    "type": "u",
                    "number": "8",
                    "building": null,
                    "stairway": null,
                    "floor": null,
                    "door": null,
                    "postBox": null
                },
                "zipCode": "2400",
                "countryCode": "HU"
            },
            "probability": 94.34476897998643,
            "recognitionFailureReason": null,
            "successfullyRecognized": true
        }
    ]
}