House Validation


DESCRIPTION

Web service.

Request

Method: GET

Content-Type: application/json

URL:

Test Environment:http://training.logiztikalliance.com:5005/logCloudApiSprint/api/integration/validhouse?house=MD1090072324&shipmentDate=2021-09-02
Production Environment:https://cloud.logiztikalliance.com:5005/logCloudApi/api/integration/validhouse?house=MD1090072324&shipmentDate=2021-09-02
INPUT PARAMETERS
NameTypeRequiredDescription
housestring(50)YesThe house number. 
shipmentDateDate(yyyy-MM-dd)YesShipment Date.
AuthenticationTokenstring(50)YesAlliance cloud security token (Bearer Token).
Response

 

Output Success

 

BODY

NameTypeDescription
validatedbooleanStatus code (True).
messagestring(150) 
destinationstring(6) 
shipmentstring(32) 
shipmentDateDateTime(yyyy-MM-ddTHH:mm:ss) 
warehouseNamestring(150) 

EXAMPLE

{
    “validated”: true,
    “message”: null,
    “destination”: “MIA”,
    “shipment”: “729-6651 6726”,
    “shipmentDate”: “2021-09-02T00:00:00”,
    “warehouseName”: “DORAL 1 NORTH G&G CARGO SERVICE”
}
Output Error

 

BODY

NameTypeDescription
validatedbooleanStatus code (False).
messagestring(150)In case of an error, we return the error message in this field.
destinationstring(6) 
shipmentstring(32) 
shipmentDateDateTime(yyyy-MM-ddTHH:mm:ss) 
warehouseNamestring(150) 

EXAMPLE

{
    “validated”: false,
    “message”: “String ‘2021-09-02s’ was not recognized as a valid DateTime.”,
    “destination”: null,
    “shipment”: null,
    “shipmentDate”: null,
    “warehouseName”: null
}
ERRORS MESSAGES

 

WRONG TOKEN

 

[]
HOUSE DOES NOT EXIST

 

{
    “validated”: false,
    “message”: “House does not exist”,
    “destination”: null,
    “shipment”: null,
    “shipmentDate”: null,
    “warehouseName”: null
}
MISSING PARAMETERS

 

{
    “validated”: false,
    “message”: “Value cannot be null. (Parameter ‘s’)”,
    “destination”: null,
    “shipment”: null,
    “shipmentDate”: null,
    “warehouseName”: null
}
DATE FORMAT ERROR

 

{
    “validated”: false,
    “message”: “String ‘2021-09-02s’ was not recognized as a valid DateTime.”,
    “destination”: null,
    “shipment”: null,
    “shipmentDate”: null,
    “warehouseName”: null
}