House Validation
DESCRIPTION
Web service.
Request
Method: GET
Content-Type: application/json
URL:
| Test Environment: | https://training.logiztikalliance.com:5005/logCloudWSSprint/api/v2/integration/validhouse?house={HOUSE}&shipmentDate={SHIPMENTDATE YYYY-MM-DD} |
| Production Environment: | https://cloud.logiztikalliance.com:5005/logCloudWS/api/v2/integration/validhouse?house={HOUSE}&shipmentDate={SHIPMENTDATE YYYY-MM-DD} |
INPUT PARAMETERS
| Name | Type | Required | Description |
| house | string(50) | Yes | The house number. |
| shipmentDate | Date(yyyy-MM-dd) | Yes | Shipment Date. |
| AuthenticationToken | string(50) | Yes | Alliance cloud security token (Api Key). |
Response
Output Success
BODY
| Name | Type | Description |
| validated | boolean | Status code (True). |
| message | string(150) | |
| destination | string(6) | |
| shipment | string(32) | |
| shipmentDate | DateTime(yyyy-MM-ddTHH:mm:ss) | |
| warehouseName | string(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
| Name | Type | Description |
| validated | boolean | Status code (False). |
| message | string(150) | In case of an error, we return the error message in this field. |
| destination | string(6) | |
| shipment | string(32) | |
| shipmentDate | DateTime(yyyy-MM-ddTHH:mm:ss) | |
| warehouseName | string(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
}