Public
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata

Ennek a metódusnak a segítségével több címet tud szétbontani.

Elérési út/mailer/recognition-result/batch
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
{
    "AddressRecognitionRequests": 
    [
        {
            "FullAddress": "This is an invalid address",
            "ConsignmentIdentifier":
            {
                "OrderId": "1",
                "ConsignmentId": "1"
            },
            "ExpectedPostDate": "2017-10-02T22:00:00Z"
        }, 
        {
            "FullAddress": "Dunaújváros Verebély u. 8 2400",
            "ConsignmentIdentifier": 
            {
                "OrderId": "1",
                "ConsignmentId": "2"
            },
            "ExpectedPostDate": "2017-10-03T22:00:00Z"
        }
    ]
}
És a hozzá tartozó példa válasz
{
    "addressRecognitionResults": 
    [
        {
            "id": 9141703,
            "consignmentIdentifier": 
            {
                "orderId": "1",
                "consignmentId": "1",
                "asOneLineString": "orderId: [1], consignmentId: [1]"
            },
            "structuredAddress": null,
            "probability": 0.0,
            "recognitionFailureReason": "INVALID_ADDRESS_FORMAT",
            "successfullyRecognized": false
        }, 
        {
            "id": 9141705,
            "consignmentIdentifier": 
            {
                "orderId": "1",
                "consignmentId": "2",
                "asOneLineString": "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
        }
    ]
}
  • No labels