- HNA-API
- Operator - Handlings
- Operator - Visits
- Operator - Voyages
- Listening
getDetachedHandling
POST
/hna/detachedHandlings:get
Operator - Handlings
Request
Body Params application/json
handlingId
string
required
Example:
d7727b42-b7d3-490e-aa70-619d7717b1d1
Example
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/hna/detachedHandlings:get' \
--header 'Content-Type: application/json' \
--data-raw ''
Responses
🟢200default response
application/json
Body
type
string
optional
declarant
object
HnaDeclarant
fullName
string
optional
shortName
string
optional
emailAddress
string | null
optional
address
string | null
optional
city
string | null
optional
countryUnCode
string | null
optional
countryName
string | null
optional
zipCode
string | null
optional
phoneNumber
string | null
optional
faxNumber
string | null
optional
contact
string | null
optional
customsEORINumber
string | null
optional
ean
string | null
optional
chamberOfCommerceNumber
string | null
optional
scacCode
string | null
optional
scacDisplayCode
string
optional
modality
string
optional
handlingId
string
optional
terminal
object
HnaResponseTerminal
shortName
string
optional
ean
string | null
optional
smdgCode
string
optional
bicsCode
string
optional
quayName
string
optional
Example:
1742
location
object
HnaLocation
allowedModalities
array[string]
optional
tarRequired
boolean
optional
roadLicenseIdRequired
boolean
optional
roadStatusRequestAllowed
boolean
optional
quaySelectByDeclarantForbidden
boolean
optional
updateAllowed
boolean
optional
maxSealNumberLength
integer <int32>
optional
acceptAfterRejectForbidden
boolean
optional
terminalSettings
array [object]
optional
prenotifyOnlyAfterVisitAccepted
boolean
optional
prenotificationRestrictedToDeclarants
object
optional
plannedQuay
object
HnaResponseTerminal
shortName
string
optional
ean
string | null
optional
smdgCode
string
optional
bicsCode
string
optional
quayName
string
optional
Example:
1742
location
object
HnaLocation
allowedModalities
array[string]
optional
tarRequired
boolean
optional
roadLicenseIdRequired
boolean
optional
roadStatusRequestAllowed
boolean
optional
quaySelectByDeclarantForbidden
boolean
optional
updateAllowed
boolean
optional
maxSealNumberLength
integer <int32>
optional
acceptAfterRejectForbidden
boolean
optional
terminalSettings
array [object]
optional
prenotifyOnlyAfterVisitAccepted
boolean
optional
prenotificationRestrictedToDeclarants
object
optional
handlingData
object
HnaHandlingData
equipmentNumber
string | null
required
Example:
BICU1234565
weight
number <double> | null
optional
>= 0<= 99999
tareWeight
number <double> | null
optional
>= 0<= 99999
sealNumber
string | null
optional
The identification number of the container seal.
reefer
object
HnaReefer
outOfGauge
object
HnaOutOfGauge
bookingNumber
string
required
shippingCompany
required
sizeType
object
HnaSizeType
type
enum<string>
required
Allowed values:
LOADINGDISCHARGE
full
boolean
optional
shippersOwned
boolean
optional
humidity
number <double> | null
optional
doorOpen
boolean | null
optional
chainWork
boolean | null
optional
generator
boolean | null
optional
damageRemark
string | null
optional
previousPort
string | null
optional
remarks
string | null
optional
Example:
Connected reefer
category
string | null
optional
nextPort
string | null
optional
finalPort
string | null
optional
modality
enum<string>
optional
Allowed values:
TRUCKBARGERAIL
Example:
barge
totalContainerWeight
number <double> | null
optional
deepSea
object
HnaHandlingDataDeepsea
inlandTerminal
object
HnaInlandTerminal
transportNumber
string | null
optional
handlingStatus
object
HnaHandlingStatus
equipmentNumber
string
optional
weight
integer <int32>
optional
tareWeight
integer <int32>
optional
sealNumber
string
optional
reefer
object
HnaReefer
outOfGauge
object
HnaOutOfGauge
window
object
HnaWindow
dangerousGoods
array[object (HnaDangerousGoods) {10}]
optional
bookingNumber
string
optional
shippingCompany
optional
sizeType
object
HnaSizeType
full
boolean
optional
shippersOwned
boolean
optional
type
string
optional
humidity
number <double>
optional
doorOpen
boolean
optional
chainWork
boolean
optional
generator
boolean
optional
damageRemark
string
optional
previousPort
string
optional
remarks
string
optional
masterBundleContainerNumber
string
optional
deepSea
object
HnaDeepsea
closestBollard
object
HnaBollard
releaseForModality
string
optional
documentsPresent
boolean
optional
notifications
array[object (HnaNotification) {3}]
optional
equipmentStatusCode
string
optional
documentNumbers
array[string]
optional
damages
array[object (HnaDamages) {2}]
optional
eta
string <date-time>
optional
cancelled
boolean
optional
attached
boolean
optional
deepSea
object
HnaDeepseaVoyage
shipName
string
optional
imoCode
string
optional
crnNumber
string
optional
voyageNumber
string
optional
eta
string
optional
etd
string
optional
expectedDischargeTime
string
optional
radioCallSign
string
optional
shipsStayReference
string
optional
cargoOpeningTime
string
optional
cargoClosingTime
string
optional
shippingAgent
string
optional
source
enum<string>
optional
Allowed values:
TERMINALAGENT
lastUpdated
string
optional
handlingDeclaration
object
HnaHandlingDeclaration
declarationUsingUpdateBypass
boolean
optional
cancelForUpdateByPassAcceptedByTerminal
boolean
optional
status
string
optional
acceptStatuses
array[object (HnaAcceptStatus) {4}]
optional
rejectReasons
array[object (HnaRejectReason) {3}]
optional
Example
{
"type": "string",
"declarant": {
"fullName": "string",
"shortName": "string",
"emailAddress": "string",
"address": "string",
"city": "string",
"countryUnCode": "string",
"countryName": "string",
"zipCode": "string",
"phoneNumber": "string",
"faxNumber": "string",
"contact": "string",
"customsEORINumber": "string",
"ean": "string",
"chamberOfCommerceNumber": "string",
"scacCode": "string",
"scacDisplayCode": "string"
},
"modality": "string",
"handlingId": "string",
"terminal": {
"shortName": "string",
"ean": "string",
"smdgCode": "string",
"bicsCode": "string",
"quayName": "1742",
"location": {
"name": "string",
"locationUnCode": "strin"
},
"allowedModalities": [
"string"
],
"tarRequired": true,
"roadLicenseIdRequired": true,
"roadStatusRequestAllowed": true,
"quaySelectByDeclarantForbidden": true,
"updateAllowed": true,
"maxSealNumberLength": 0,
"acceptAfterRejectForbidden": true,
"terminalSettings": [
{}
],
"prenotifyOnlyAfterVisitAccepted": true,
"prenotificationRestrictedToDeclarants": {}
},
"plannedQuay": {
"shortName": "string",
"ean": "string",
"smdgCode": "string",
"bicsCode": "string",
"quayName": "1742",
"location": {
"name": "string",
"locationUnCode": "strin"
},
"allowedModalities": [
"string"
],
"tarRequired": true,
"roadLicenseIdRequired": true,
"roadStatusRequestAllowed": true,
"quaySelectByDeclarantForbidden": true,
"updateAllowed": true,
"maxSealNumberLength": 0,
"acceptAfterRejectForbidden": true,
"terminalSettings": [
{}
],
"prenotifyOnlyAfterVisitAccepted": true,
"prenotificationRestrictedToDeclarants": {}
},
"handlingData": {
"equipmentNumber": "BICU1234565",
"weight": 0,
"tareWeight": 0,
"sealNumber": "string",
"reefer": {
"temperatureFixed": true,
"temperature": -999,
"minimumTemperature": -999,
"maximumTemperature": -999
},
"outOfGauge": {
"left": 0,
"front": 0,
"height": 0,
"right": 0,
"rear": 0
},
"bookingNumber": "string",
"shippingCompany": {
"name": "string",
"scacCode": "stri",
"scacDisplayCode": "string",
"smdgCode": "str"
},
"sizeType": {
"code": "22G1",
"name": "20'x8'x8'6\\\" General Purpose Container"
},
"type": "LOADING",
"full": true,
"shippersOwned": true,
"humidity": 0,
"doorOpen": true,
"chainWork": true,
"generator": true,
"damageRemark": "string",
"previousPort": "string",
"remarks": "Connected reefer",
"category": "string",
"nextPort": "string",
"finalPort": "string",
"modality": "TRUCK",
"totalContainerWeight": 0,
"deepSea": {
"shipName": "string",
"imoCode": "string",
"crnNumber": "string"
},
"inlandTerminal": {
"name": "string",
"location": {
"name": "string",
"locationUnCode": "strin"
}
},
"transportNumber": "string"
},
"handlingStatus": {
"equipmentNumber": "string",
"weight": 0,
"tareWeight": 0,
"sealNumber": "string",
"reefer": {
"temperatureFixed": true,
"temperature": -999,
"minimumTemperature": -999,
"maximumTemperature": -999
},
"outOfGauge": {
"left": 0,
"front": 0,
"height": 0,
"right": 0,
"rear": 0
},
"window": {
"start": "string",
"end": "string"
},
"dangerousGoods": [
{
"name": "string",
"unCode": "1150",
"hazardClass": "1",
"subsidiaryRisk": "1",
"emsFireCode": "string",
"emsSpillageCode": "string",
"properties": "string",
"segregationGroup": "string",
"packingGroup": "string",
"flashPoint": 0
}
],
"bookingNumber": "string",
"shippingCompany": {
"name": "string",
"scacCode": "stri",
"scacDisplayCode": "string",
"smdgCode": "str"
},
"sizeType": {
"code": "22G1",
"name": "20'x8'x8'6\\\" General Purpose Container"
},
"full": true,
"shippersOwned": true,
"type": "string",
"humidity": 0,
"doorOpen": true,
"chainWork": true,
"generator": true,
"damageRemark": "string",
"previousPort": "string",
"remarks": "string",
"masterBundleContainerNumber": "string",
"deepSea": {
"shipName": "string",
"imoCode": "string",
"voyageNUmber": "string",
"eta": "string",
"etd": "string",
"expectedDischargeTime": "string",
"radioCallSign": "string",
"shipsStayReference": "string"
},
"closestBollard": {
"bicsCode": "string",
"number": "string",
"coordinates": {},
"metersToNextBollard": 0,
"mooringSide": "port"
},
"releaseForModality": "string",
"documentsPresent": true,
"notifications": [
{
"level": "string",
"code": "string",
"description": "string"
}
],
"equipmentStatusCode": "string",
"documentNumbers": [
"string"
],
"damages": [
{
"typeOfDamages": "string",
"damageArea": "string"
}
]
},
"eta": "2019-08-24T14:15:22Z",
"cancelled": true,
"attached": true,
"deepSea": {
"shipName": "string",
"imoCode": "string",
"crnNumber": "string",
"voyageNumber": "string",
"eta": "string",
"etd": "string",
"expectedDischargeTime": "string",
"radioCallSign": "string",
"shipsStayReference": "string",
"cargoOpeningTime": "string",
"cargoClosingTime": "string",
"shippingAgent": "string",
"source": "TERMINAL",
"lastUpdated": "string"
},
"handlingDeclaration": {
"declarationUsingUpdateBypass": true,
"cancelForUpdateByPassAcceptedByTerminal": true,
"status": "string",
"acceptStatuses": [
{
"type": "COMMERCIAL_RELEASE",
"ok": true,
"code": "string",
"remark": "string"
}
],
"rejectReasons": [
{
"code": "string",
"terminalDescription": "string",
"parsedReason": "string"
}
]
}
}
Modified at 2024-08-19 11:18:45