DrayX Orchestration Web API (v3)

Download OpenAPI specification:Download

eModal: eModal@emodal.com URL: http://emodal.com Terms of Service

DrayX Orchestration Web API Swagger Surface

Common

/api/Common/GetDrayXchanges

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetDrayXchanges

/api/Common/GetFacilities

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetFacilities

/api/Common/GetFacilitiesByXchgID/{lDrayXchg_Id}

SecurityX-API-Key

Request

path Parameters

lDrayXchg_Id

required

string

Responses

200

Success

get/api/Common/GetFacilitiesByXchgID/{lDrayXchg_Id}

/api/Common/GetAssociatedCompanies/{bcoCompanyId}

SecurityX-API-Key

Request

path Parameters

bcoCompanyId

required

string

Responses

200

Success

get/api/Common/GetAssociatedCompanies/{bcoCompanyId}

/api/Common/GetCompanyFacilities/{Company_Uid}

SecurityX-API-Key

Request

path Parameters

Company_Uid

required

string <uuid>

Responses

200

Success

get/api/Common/GetCompanyFacilities/{Company_Uid}

/api/Common/GetPorts

SecurityX-API-Key

Request

query Parameters

portCd

string

Responses

200

Success

get/api/Common/GetPorts

/api/Common/GetPortFacilities/{Port_Cd}

SecurityX-API-Key

Request

path Parameters

Port_Cd

required

string

Responses

200

Success

get/api/Common/GetPortFacilities/{Port_Cd}

Response samples

200

No sample

/api/Common/GetVessel/{sVessel}

SecurityX-API-Key

Request

path Parameters

sVessel

required

string

Responses

200

Success

get/api/Common/GetVessel/{sVessel}

Response samples

200

No sample

/api/Common/GetVesselDetails

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

Array

key	string or null
filter	string or null

Responses

200

Success

post/api/Common/GetVesselDetails

Request samples

Payload

[{"key": "string",
"filter": "string"
}
]

Response samples

200

No sample

/api/Common/GetDrayUnitActivity

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetDrayUnitActivity

/api/Common/GetServiceStatuses

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetServiceStatuses

/api/Common/GetSvcAccTypes

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetSvcAccTypes

Response samples

200

No sample

/api/Common/GetDrayUnitStatuses

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetDrayUnitStatuses

/api/Common/GetUnitStatuses

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetUnitStatuses

/api/Common/GetUnitInfo

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

unitCategory_Cd	string
unit10_Nbr	string or null

Responses

200

Success

post/api/Common/GetUnitInfo

Request samples

Payload

{"unitCategory_Cd": "string",
"unit10_Nbr": "string"
}

Response samples

200

No sample

/api/Common/GetUnitCategory

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetUnitCategory

Response samples

200

No sample

/api/Common/GetDeliveryType

SecurityX-API-Key

Responses

200

Success

get/api/Common/GetDeliveryType

Response samples

200

No sample

/api/Common/GetInterfaceFieldsSearchSort/{sInterfaceKey}

SecurityX-API-Key

Request

path Parameters

sInterfaceKey

required

string

Responses

200

Success

get/api/Common/GetInterfaceFieldsSearchSort/{sInterfaceKey}

GetInterfaceFieldsSearch

SecurityX-API-Key

Request

path Parameters

sInterfaceKey

required

string

Responses

200

Success

get/api/Common/GetInterfaceFieldsSearch/{sInterfaceKey}

/api/Common/SaveUserInterfaceSortPreference

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/Common/SaveUserInterfaceSortPreference

Request samples

Payload

"string"

/api/Common/RemoveUserInterfaceSortPreference

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

string

Responses

200

Success

post/api/Common/RemoveUserInterfaceSortPreference

Request samples

Payload

"string"

/api/Common/ExportToExcel

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

	Array of objects or null (ClientSearch)
	Array of objects or null (ClientSort)
interfaceKey	string or null

Responses

200

Success

post/api/Common/ExportToExcel

Request samples

Payload

{"clientSearch": [{"mem": "string",
"value": "string"
}
],
"clientSort": [{"mem": "string",
"dirn": 0
}
],
"interfaceKey": "string"
}

Response samples

200

No sample

GetApplicationResourceStrings

SecurityX-API-Key

Request

path Parameters

sLocale

required

string

query Parameters

sLocale

string

Responses

200

Success

get/api/Common/GetApplicationResourceStrings/{sLocale}

Response samples

200

No sample

GetInterfaceFields

SecurityX-API-Key

Request

path Parameters

sInterfaceKey required	string
sLocale required	string

Responses

200

Success

get/api/Common/GetInterfaceFields/{sInterfaceKey}/{sLocale}

Get Interface fields for facility

SecurityX-API-Key

Request

path Parameters

sInterfaceKey required	string
sLocale required	string
sFacilityId required	string

Responses

200

Success

get/api/Common/GetInterfaceFields/{sInterfaceKey}/{sLocale}/{sFacilityId}

/api/Common/GetSvcProviderFacility/{svc_cd}/{port_cd}

SecurityX-API-Key

Request

path Parameters

svc_cd required	string
port_cd required	string

Responses

200

Success

get/api/Common/GetSvcProviderFacility/{svc_cd}/{port_cd}

Response samples

200

No sample

/api/Common/GetTimeZoneInfoByTimeZone_Id/{TimeZone_Id}

SecurityX-API-Key

Request

path Parameters

TimeZone_Id

required

integer <int64>

Responses

200

Success

get/api/Common/GetTimeZoneInfoByTimeZone_Id/{TimeZone_Id}

Response samples

200

No sample

/api/Common/GetFacilityTimeZone/{Facility_Cd}

SecurityX-API-Key

Request

path Parameters

Facility_Cd

required

string

Responses

200

Success

get/api/Common/GetFacilityTimeZone/{Facility_Cd}

/api/Common/GetFacilityByCode/{facilityCd}

SecurityX-API-Key

Request

path Parameters

facilityCd

required

string

Responses

200

Success

get/api/Common/GetFacilityByCode/{facilityCd}

/api/Common/UserInfoByToken

SecurityX-API-Key

Request

query Parameters

accessToken

string

Responses

200

Success

get/api/Common/UserInfoByToken

/api/Common/SaveFacility

SecurityX-API-Key

Request

Request Body schema:
application/json-patch+json

facility_Id	string <uuid>
facility_Cd	string or null
facility_Nm	string or null
facility_Addr	string or null
facilityOwner	integer <int64>
facilityOwnerInfo_Json	string or null
facilityTimeZone	integer <int64>
facilityProfile	string or null
delete_Flg	boolean
timeZone_Nm	string or null
facilityType_Cd	string
facility_Alias	string or null
apptMTODisplay_Cd	string or null
apptType_Cd	string or null
port_Cd	string or null
company_Uid	string or null <uuid>

Responses

200

Success

post/api/Common/SaveFacility

Request samples

Payload

{"facility_Id": "8b605249-5b80-474a-8bb0-d3d173a32160",
"facility_Cd": "string",
"facility_Nm": "string",
"facility_Addr": "string",
"facilityOwner": 0,
"facilityOwnerInfo_Json": "string",
"facilityTimeZone": 0,
"facilityProfile": "string",
"delete_Flg": true,
"timeZone_Nm": "string",
"facilityType_Cd": "string",
"facility_Alias": "string",
"apptMTODisplay_Cd": "string",
"apptType_Cd": "string",
"port_Cd": "string",
"company_Uid": "e2d766a1-9a30-4a0a-a4dd-b493c0f915b3"
}

Response samples

200

No sample

DrayX Orchestration Web API (v3)

Common

/api/Common/GetDrayXchanges

/api/Common/GetFacilities

/api/Common/GetFacilitiesByXchgID/{lDrayXchg_Id}

path Parameters

/api/Common/GetAssociatedCompanies/{bcoCompanyId}

path Parameters

/api/Common/GetCompanyFacilities/{Company_Uid}

path Parameters

/api/Common/GetPorts

query Parameters

/api/Common/GetPortFacilities/{Port_Cd}

path Parameters

/api/Common/GetVessel/{sVessel}

path Parameters

/api/Common/GetVesselDetails

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

/api/Common/GetDrayUnitActivity

/api/Common/GetServiceStatuses

/api/Common/GetSvcAccTypes

/api/Common/GetDrayUnitStatuses

/api/Common/GetUnitStatuses

/api/Common/GetUnitInfo

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

/api/Common/GetUnitCategory

/api/Common/GetDeliveryType

/api/Common/GetInterfaceFieldsSearchSort/{sInterfaceKey}

path Parameters

GetInterfaceFieldsSearch

path Parameters

/api/Common/SaveUserInterfaceSortPreference

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

/api/Common/RemoveUserInterfaceSortPreference

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

/api/Common/ExportToExcel

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

GetApplicationResourceStrings

path Parameters

query Parameters

GetInterfaceFields

path Parameters

Get Interface fields for facility

path Parameters

/api/Common/GetSvcProviderFacility/{svc_cd}/{port_cd}

path Parameters

/api/Common/GetTimeZoneInfoByTimeZone_Id/{TimeZone_Id}

path Parameters

/api/Common/GetFacilityTimeZone/{Facility_Cd}

path Parameters

/api/Common/GetFacilityByCode/{facilityCd}

path Parameters

/api/Common/UserInfoByToken

query Parameters

/api/Common/SaveFacility

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/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