DrayXOrchestrator

/api/DrayXOrchestrator/SubmitDrayageOrchestration

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/DrayXOrchestrator/SubmitDrayageOrchestration

Request samples

Payload

"string"

/api/DrayXOrchestrator/ManageServices

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/DrayXOrchestrator/ManageServices

Request samples

Payload

"string"

/api/DrayXOrchestrator/ProcessOrchestrationRequest

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

	object (DX_Header)
	Array of objects or null (DX_Order)

Responses

200

Success

post/api/DrayXOrchestrator/ProcessOrchestrationRequest

Request samples

Payload

{"header": {"company_Identifier": "string",
"contactPerson": "string",
"user_Identifier": "string",
"email": "string"
},
"order": [{"trade_Type": "string",
"billoflading": "string",
"vesselInfo": {"scac": "string",
"vessel_Name": "string",
"voyage_Nbr": "string"
},
"unit": {"unit_Nbr": "string",
"unit_Category": "string",
"line_Scac": "string",
"sztypISO": "string",
"seal_Nbr": ["string"
]
},
"unitStatusInfo": {"status_Cd": "string",
"status_Desc": "string",
"unituse_Cd": "string",
"unituse_Desc": "string"
},
"appointment_Info": {"appt_Nbr": "string",
"appt_Type": "string",
"appt_Status": "string",
"appt_DtTm": "string",
"apptCal_Dttm": "string",
"appt_Uid": "string"
},
"gross_Weight": 0,
"gross_Weight_UOM": "string",
"cargo_Weight": 0,
"cargo_Weight_UOM": "string",
"tare_Weight": 0,
"tare_Weight_UOM": "string",
"locations": [{"location_Type": "string",
"location_Cd": "string",
"port_Cd": "string",
"unloc_Cd": "string",
"bcO_Location_Code": "string",
"facility_Name": "string",
"facility_Address": "string",
"city": "string",
"state": "string",
"postal_Code": "string",
"lat_long": "string",
"delivery_Type": "string",
"reservation_Details": {"reservation_Preferences": {"tryLaterDates": "string",
"threshold": "string",
"preference_Datetimes": [[ ]
],
"timePreference": [null
],
"guarantee_Through_Date": "string"
},
"hazmat_Info": {"haz_Class": "string",
"haz_UnCode": "string",
"commodity_Weight": "string",
"quantity": "string",
"package_Group": "string",
"commodity_Name": "string",
"emergency_Ph": "string",
"limited_Qty": "string",
"comments": "string"
},
"trucker_Info": {"trucking_Company_Uid": "dbc3a13a-099f-48a3-ac74-e0ef441585ec",
"trucker_Scac": "string",
"truck_Nbr": "string",
"lic_Plate_Nbr": "string",
"lic_Plate_State_Cd": "string",
"driver_Id": "string",
"driver_Fname": "string",
"driver_Lname": "string"
},
"pin_Nbr": "string",
"dualUnit": {"unit": {"unit_Nbr": null,
"unit_Category": null,
"line_Scac": null,
"sztypISO": null,
"seal_Nbr": [ ]
},
"drayUnit_Id": 0
}
},
"services": [{"service_Cd": "string",
"lineItems": [null
]
}
]
}
],
"stakeholders": [{"scac": "string",
"company_Cd": "string"
}
]
}
]
}

/api/DrayXOrchestrator/SubmitOrchestrationMessage

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

emailSubject	string or null
fileName	string or null
recievedDate	string or null
to	string or null
bcc	string or null
recordCount	integer <int32>
newCount	integer <int32>
updateCount	integer <int32>
errorCount	integer <int32>
	Array of objects or null (FileErrorModel)
company_Nm	string or null
user_Nm	string or null
company_Uid	string or null

Responses

200

Success

post/api/DrayXOrchestrator/SubmitOrchestrationMessage

Request samples

Payload

{"emailSubject": "string",
"fileName": "string",
"recievedDate": "string",
"to": "string",
"bcc": "string",
"recordCount": 0,
"newCount": 0,
"updateCount": 0,
"errorCount": 0,
"errors": [{"port": "string",
"containerNumber": "string",
"errorDescription": "string"
}
],
"company_Nm": "string",
"user_Nm": "string",
"company_Uid": "string"
}

/api/DrayXOrchestrator/StopOrchestrationByUid

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string <uuid>

Responses

200

Success

post/api/DrayXOrchestrator/StopOrchestrationByUid

Request samples

Payload

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

/api/DrayXOrchestrator/UpdateDrayUnitStatusByUid

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string <uuid>

Responses

200

Success

post/api/DrayXOrchestrator/UpdateDrayUnitStatusByUid

Request samples

Payload

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Response samples

200

No sample

/api/DrayXOrchestrator/NotifyPaymentsOfContainerNotFound/{drayUnitUId}

SecurityX-API-Key

Request

path Parameters

drayUnitUId

required

string <uuid>

Responses

200

Success

post/api/DrayXOrchestrator/NotifyPaymentsOfContainerNotFound/{drayUnitUId}

/api/DrayXOrchestrator/ProcessAppointmentResponse/{drayUnitUId}

SecurityX-API-Key

Request

path Parameters

drayUnitUId

required

string <uuid>

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/DrayXOrchestrator/ProcessAppointmentResponse/{drayUnitUId}

Request samples

Payload

"string"

/api/DrayXOrchestrator/GetExistingDrayUnit

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/DrayXOrchestrator/GetExistingDrayUnit

Request samples

Payload

"string"

Response samples

200

No sample

/api/DrayXOrchestrator/SendContainerNotification

SecurityX-API-Key

Request

query Parameters

companyUId	string <uuid>
container_nbr	string
trade_type	string
send_preferences	boolean

Responses

200

Success

post/api/DrayXOrchestrator/SendContainerNotification

/api/DrayXOrchestrator/LogDrayUnitException

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

trade_Type	string or null
status_cd	string or null
unit_nbr	string or null
service_cd	string or null
	Array of objects or null (ExceptionMessage)

Responses

200

Success

post/api/DrayXOrchestrator/LogDrayUnitException

Request samples

Payload

{"trade_Type": "string",
"status_cd": "string",
"unit_nbr": "string",
"service_cd": "string",
"service_msg": [{"msg_sev": "string",
"msg_cd": "string",
"msg_desc": "string"
}
]
}

Response samples

200

No sample

/api/DrayXOrchestrator/LogPaymentAvailability

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

containernumber	string or null
location_cd	string or null
guaranteethroughdate	string <date-time>
trade_type	string or null

Responses

200

Success

post/api/DrayXOrchestrator/LogPaymentAvailability

Request samples

Payload

{"containernumber": "string",
"location_cd": "string",
"guaranteethroughdate": "2019-08-24T14:15:22Z",
"trade_type": "string"
}

Response samples

200

No sample

/api/DrayXOrchestrator/UpdateDrayUnitJobStatus

SecurityX-API-Key

Request

query Parameters

drayUnitUid	string <uuid>
jobStatus	string
hasDualMove	string
locationType	string

Responses

200

Success

post/api/DrayXOrchestrator/UpdateDrayUnitJobStatus

Response samples

200

No sample

/api/DrayXOrchestrator/UpdateDrayUnitApptNbr

SecurityX-API-Key

Request

query Parameters

drayUnitUid	string <uuid>
apptNbr	string

Responses

200

Success

post/api/DrayXOrchestrator/UpdateDrayUnitApptNbr

Response samples

200

No sample

/api/DrayXOrchestrator/ChargeTransaction

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

companyUId	string <uuid>
serviceOrderUId	string <uuid>
transactionType	string or null

Responses

200

Success

post/api/DrayXOrchestrator/ChargeTransaction

Request samples

Payload

{"companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
"serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
"transactionType": "string"
}

/api/DrayXOrchestrator/PostTerminalDrayUnitException

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

drayUnit_Uid	string <uuid>
location_cd	string or null

Responses

200

Success

post/api/DrayXOrchestrator/PostTerminalDrayUnitException

Request samples

Payload

{"drayUnit_Uid": "679c487a-4cba-4f56-b5c2-f260d6b35220",
"location_cd": "string"
}

Response samples

200

No sample

/api/DrayXOrchestrator/PostOrchestrationUpdateMsg

SecurityX-API-Key

Request

query Parameters

companyUId	string <uuid>
container_nbr	string
trade_type	string

Responses

200

Success

post/api/DrayXOrchestrator/PostOrchestrationUpdateMsg

/api/DrayXOrchestrator/GetPaymentSupportTerminal/{locationCd}

SecurityX-API-Key

Request

path Parameters

locationCd

required

string

Responses

200

Success

get/api/DrayXOrchestrator/GetPaymentSupportTerminal/{locationCd}

Response samples

200

No sample

DrayXOrchestrator

/api/DrayXOrchestrator/SubmitDrayageOrchestration

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/ManageServices

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/ProcessOrchestrationRequest

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/SubmitOrchestrationMessage

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/StopOrchestrationByUid

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/UpdateDrayUnitStatusByUid

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/NotifyPaymentsOfContainerNotFound/{drayUnitUId}

path Parameters

/api/DrayXOrchestrator/ProcessAppointmentResponse/{drayUnitUId}

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/GetExistingDrayUnit

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/SendContainerNotification

query Parameters

/api/DrayXOrchestrator/LogDrayUnitException

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/LogPaymentAvailability

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/UpdateDrayUnitJobStatus

query Parameters

/api/DrayXOrchestrator/UpdateDrayUnitApptNbr

query Parameters

/api/DrayXOrchestrator/ChargeTransaction

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/PostTerminalDrayUnitException

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

/api/DrayXOrchestrator/PostOrchestrationUpdateMsg

query Parameters

/api/DrayXOrchestrator/GetPaymentSupportTerminal/{locationCd}

path Parameters

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json