Ennek a metódusnak a segítségével több címet tud szétbontani.
Elérési út | /mailer/batch-recognize |
Http művelet | POST |
Kérés objektum | BatchMailerAddressRecognitionRequest |
Válasz objektum | BatchMailerAddressRecognitionResponse |
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
|
Code Block |
---|
language | js |
---|
title | Pé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 |
---|
language | js |
---|
title | Pé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
}
]
} |