Skip to content

eModal TermOps Pregate Gateway API (v1)

eModal TermOps Pregate Gateway API

Metadata

KeyValue
productPregate
Download OpenAPI description
Languages
Servers
Mock server
https://developer.cargosprint.com/_mock/pregate/openapi

External

Operations

/api/External/about

Request

curl -i -X GET \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/about

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

/api/External/GetTerminalInfoByMTO_Cd

Request

Query
mtoCdstring
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetTerminalInfoByMTO_Cd?mtoCd=string'

Responses

OK

Bodyapplication/json
mtO_Idinteger(int64)
mtO_Cdstring or null
mtO_Nmstring or null
mtoDisplay_Cdstring or null
port_cdstring or null
location_Cdstring or null
ecpMto_Cdstring or null
tiPartner_Cdstring or null
company_Idinteger(int64)
apptTypesArray of objects or null(ApptType)
Response
application/json
{ "mtO_Id": 0, "mtO_Cd": "string", "mtO_Nm": "string", "mtoDisplay_Cd": "string", "port_cd": "string", "location_Cd": "string", "ecpMto_Cd": "string", "tiPartner_Cd": "string", "company_Id": 0, "apptTypes": [ {} ] }

/api/External/GetVisitsData

Request

Query
sVisitIdstring
facilityIdinteger(int32)
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetVisitsData?sVisitId=string&facilityId=0'

Responses

OK

Bodyapplication/json
actionstring or null
activeTerminalstring or null
associatedCompanyinteger(int64)
associatedCompanyNamestring or null
truckingCompany_Uidstring or null
editVisibilityArray of integers or null(int32)
selectedSlotobject(TextValuePair)
visitobject(TruckVisit)
movesArray of objects or null(TruckVisitMove)
generalMessagesArray of objects or null(GateResponseMessage)
isDisplayFeeCatboolean
claimFeesCatArray of objects or null(ClaimFeesCat)
allowFeePaymentsboolean
feeItemsArray of objects or null(ApptTariffFee)
addToCartFeeCodesArray of strings or null
availableTerminalListArray of objects or null(TextValuePair)
scaclessboolean or null
Response
application/json
{ "action": "string", "activeTerminal": "string", "associatedCompany": 0, "associatedCompanyName": "string", "truckingCompany_Uid": "string", "editVisibility": [ 0 ], "selectedSlot": { "text": "string", "value": null }, "visit": { "visitUIId": 0, "truckGroup_UId": "521948b3-f6c8-4697-8fd8-89a4254571cb", "truckGroup_Name": "string", "mtO_Id": 0, "mtoDisplay_Cd": "string", "truckVisit_Id": 0, "truckvisitFeeResponsibleParty_Id": 0, "responsiblePartyCompany_Uid": "string", "claimAllFees_Flg": "string", "visitDisplay_Nm": "string", "truckPlate_Num": "string", "rfiD_Cd": "string", "pool_Cd": "string", "apptPool_Id": 0, "apptSlotSchedule_Id": 0, "request_Identifier": "537ec0e0-4eef-431c-b124-258dc4d8e079", "request_Source": "string", "request_Source_Identifier": "string", "visitMoveDate": "string", "trucker_FirstName": "string", "messages": [], "createUser_Id": 0, "create_DtTm": "2019-08-24T14:15:22Z", "initialSS_Id": 0, "userAction": "string", "visitBusn_Dt": "2019-08-24T14:15:22Z", "visitFrom_Tm": "2019-08-24T14:15:22Z", "visitTo_Tm": "2019-08-24T14:15:22Z", "visitFrom_DtTm": "2019-08-24T14:15:22Z", "visitTo_DtTm": "2019-08-24T14:15:22Z", "company_Id": 0, "company_Uid": "string", "isRecommendedSlot": true }, "moves": [ {} ], "generalMessages": [ {} ], "isDisplayFeeCat": true, "claimFeesCat": [ {} ], "allowFeePayments": true, "feeItems": [ {} ], "addToCartFeeCodes": [ "string" ], "availableTerminalList": [ {} ], "scacless": true }

/api/External/GetVisitbyMoveIdentifier

Request

Query
sMoveIdentifierstring
facilityIdinteger(int32)
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetVisitbyMoveIdentifier?sMoveIdentifier=string&facilityId=0'

Responses

OK

Bodyapplication/json
actionstring or null
activeTerminalstring or null
associatedCompanyinteger(int64)
associatedCompanyNamestring or null
truckingCompany_Uidstring or null
editVisibilityArray of integers or null(int32)
selectedSlotobject(TextValuePair)
visitobject(TruckVisit)
movesArray of objects or null(TruckVisitMove)
generalMessagesArray of objects or null(GateResponseMessage)
isDisplayFeeCatboolean
claimFeesCatArray of objects or null(ClaimFeesCat)
allowFeePaymentsboolean
feeItemsArray of objects or null(ApptTariffFee)
addToCartFeeCodesArray of strings or null
availableTerminalListArray of objects or null(TextValuePair)
scaclessboolean or null
Response
application/json
{ "action": "string", "activeTerminal": "string", "associatedCompany": 0, "associatedCompanyName": "string", "truckingCompany_Uid": "string", "editVisibility": [ 0 ], "selectedSlot": { "text": "string", "value": null }, "visit": { "visitUIId": 0, "truckGroup_UId": "521948b3-f6c8-4697-8fd8-89a4254571cb", "truckGroup_Name": "string", "mtO_Id": 0, "mtoDisplay_Cd": "string", "truckVisit_Id": 0, "truckvisitFeeResponsibleParty_Id": 0, "responsiblePartyCompany_Uid": "string", "claimAllFees_Flg": "string", "visitDisplay_Nm": "string", "truckPlate_Num": "string", "rfiD_Cd": "string", "pool_Cd": "string", "apptPool_Id": 0, "apptSlotSchedule_Id": 0, "request_Identifier": "537ec0e0-4eef-431c-b124-258dc4d8e079", "request_Source": "string", "request_Source_Identifier": "string", "visitMoveDate": "string", "trucker_FirstName": "string", "messages": [], "createUser_Id": 0, "create_DtTm": "2019-08-24T14:15:22Z", "initialSS_Id": 0, "userAction": "string", "visitBusn_Dt": "2019-08-24T14:15:22Z", "visitFrom_Tm": "2019-08-24T14:15:22Z", "visitTo_Tm": "2019-08-24T14:15:22Z", "visitFrom_DtTm": "2019-08-24T14:15:22Z", "visitTo_DtTm": "2019-08-24T14:15:22Z", "company_Id": 0, "company_Uid": "string", "isRecommendedSlot": true }, "moves": [ {} ], "generalMessages": [ {} ], "isDisplayFeeCat": true, "claimFeesCat": [ {} ], "allowFeePayments": true, "feeItems": [ {} ], "addToCartFeeCodes": [ "string" ], "availableTerminalList": [ {} ], "scacless": true }

/api/External/GetTerminalData

Request

Bodyapplication/json
facilityIdinteger(int32)
profileParameter_CdsArray of strings or null
userActionstring or null
visitIdsArray of strings or null
isSingleVisitboolean
truckingCompanyNamestring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetTerminalData \
  -H 'Content-Type: application/json' \
  -d '{
    "facilityId": 0,
    "profileParameter_Cds": [
      "string"
    ],
    "userAction": "string",
    "visitIds": [
      "string"
    ],
    "isSingleVisit": true,
    "truckingCompanyName": "string"
  }'

Responses

OK

Bodyapplication/json
moveTypeAddApptsArray of objects or null(MoveTypeAddAppt)
shippingLinesobject(ShippingLines)
chassisSizeTypeListArray of objects or null(ChassisSizeType)
isoArcheTypesListArray of objects or null(IsoArcheType)
claimFeeCatListArray of objects or null(MoveFeeClaim)
facilityProfileValuesArray of objects or null(FacilityProfileValue)
facilityMoveTypeProfileValuesArray of objects or null(FacilityMoveTypeProfileValue)
checkInConfigsobject(CheckInConfiguration)
uomDetailsArray of objects or null(TextValuePair)
facilityIsoArchTypesListArray of objects or null(FacilityIsoArchType)
inventoryRulesArray of objects or null(Rule)
truckPlateListobject(TruckPlates)
step1ConfigsArray of objects or null(UIConfigStep1)
allConfigStepArray of objects or null(UIConfigAllStep)
Response
application/json
{ "moveTypeAddAppts": [ {} ], "shippingLines": { "mtO_Id": 0, "list": [] }, "chassisSizeTypeList": [ {} ], "isoArcheTypesList": [ {} ], "claimFeeCatList": [ {} ], "facilityProfileValues": [ {} ], "facilityMoveTypeProfileValues": [ {} ], "checkInConfigs": { "preAdviceMsg": "string", "pregateMsg": "string", "configs": [] }, "uomDetails": [ {} ], "facilityIsoArchTypesList": [ {} ], "inventoryRules": [ {} ], "truckPlateList": { "companyName": "string", "plateNames": [] }, "step1Configs": [ {} ], "allConfigStep": [ {} ] }

/api/External/GetTruckingCompanyAppointments

Request

Bodyapplication/json
apptType_Cdstring or null
mto_Cdstring or null
truckingCompany_Uidsstring or null
scaC_Cdsstring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetTruckingCompanyAppointments \
  -H 'Content-Type: application/json' \
  -d '{
    "apptType_Cd": "string",
    "mto_Cd": "string",
    "truckingCompany_Uids": "string",
    "scaC_Cds": "string"
  }'

Responses

OK

Bodyapplication/json
companyIDinteger(int32)
truckingCompanyUIDstring(uuid)
companyNamestring or null
mto_Cdstring or null
ecpMto_Cdstring or null
apptType_Cdstring or null
scacstring or null
apptStatus_Cdstring or null
Response
application/json
{ "companyID": 0, "truckingCompanyUID": "367bce8a-d848-4fb1-8a77-3d40c3fd88fe", "companyName": "string", "mto_Cd": "string", "ecpMto_Cd": "string", "apptType_Cd": "string", "scac": "string", "apptStatus_Cd": "string" }

/api/External/GetTruckingCompanyBySCAC

Request

Bodyapplication/json
apptType_Cdstring or null
mto_Cdstring or null
truckingCompany_Uidsstring or null
scaC_Cdsstring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetTruckingCompanyBySCAC \
  -H 'Content-Type: application/json' \
  -d '{
    "apptType_Cd": "string",
    "mto_Cd": "string",
    "truckingCompany_Uids": "string",
    "scaC_Cds": "string"
  }'

Responses

OK

Bodyapplication/json
companyIDinteger(int32)
truckingCompanyUIDstring(uuid)
companyNamestring or null
mto_Cdstring or null
ecpMto_Cdstring or null
apptType_Cdstring or null
scacstring or null
apptStatus_Cdstring or null
Response
application/json
{ "companyID": 0, "truckingCompanyUID": "367bce8a-d848-4fb1-8a77-3d40c3fd88fe", "companyName": "string", "mto_Cd": "string", "ecpMto_Cd": "string", "apptType_Cd": "string", "scac": "string", "apptStatus_Cd": "string" }

/api/External/GetContainerAppointmentStatus

Request

Bodyapplication/json
container_Numstring or null
apptType_Cdstring or null
from_Datestring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetContainerAppointmentStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "container_Num": "string",
    "apptType_Cd": "string",
    "from_Date": "string"
  }'

Responses

OK

Bodyapplication/json
container_Numstring or null
apptType_Cdstring or null
from_Datestring(date-time)
appointmentStatusDataArray of objects or null(AppointmentStatusData)
Response
application/json
{ "container_Num": "string", "apptType_Cd": "string", "from_Date": "2019-08-24T14:15:22Z", "appointmentStatusData": [ {} ] }

/api/External/GetAvailableSlots

Request

Bodyapplication/json
visitsArray of objects or null(ClientVisit)
ruleStagestring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetAvailableSlots \
  -H 'Content-Type: application/json' \
  -d '{
    "visits": [
      {
        "action": "string",
        "activeTerminal": "string",
        "associatedCompany": 0,
        "associatedCompanyName": "string",
        "truckingCompany_Uid": "string",
        "editVisibility": [
          0
        ],
        "selectedSlot": {
          "text": "string",
          "value": null
        },
        "visit": {
          "visitUIId": 0,
          "truckGroup_UId": "521948b3-f6c8-4697-8fd8-89a4254571cb",
          "truckGroup_Name": "string",
          "mtO_Id": 0,
          "mtoDisplay_Cd": "string",
          "truckVisit_Id": 0,
          "truckvisitFeeResponsibleParty_Id": 0,
          "responsiblePartyCompany_Uid": "string",
          "claimAllFees_Flg": "string",
          "visitDisplay_Nm": "string",
          "truckPlate_Num": "string",
          "rfiD_Cd": "string",
          "pool_Cd": "string",
          "apptPool_Id": 0,
          "apptSlotSchedule_Id": 0,
          "request_Identifier": "537ec0e0-4eef-431c-b124-258dc4d8e079",
          "request_Source": "string",
          "request_Source_Identifier": "string",
          "visitMoveDate": "string",
          "trucker_FirstName": "string",
          "messages": [
            {
              "messageid": "string",
              "messageseverity": 0,
              "messagetext": "string",
              "messagedetail": "string",
              "messageservicecd": "string"
            }
          ],
          "createUser_Id": 0,
          "create_DtTm": "2019-08-24T14:15:22Z",
          "initialSS_Id": 0,
          "userAction": "string",
          "visitBusn_Dt": "2019-08-24T14:15:22Z",
          "visitFrom_Tm": "2019-08-24T14:15:22Z",
          "visitTo_Tm": "2019-08-24T14:15:22Z",
          "visitFrom_DtTm": "2019-08-24T14:15:22Z",
          "visitTo_DtTm": "2019-08-24T14:15:22Z",
          "company_Id": 0,
          "company_Uid": "string",
          "isRecommendedSlot": true
        },
        "moves": [
          {
            "moveUIId": 0,
            "mtoDisplay_Cd": "string",
            "mtO_Id": 0,
            "con_Cd": "string",
            "equipmentIso_Cd": "string",
            "gateAppt_Id": 0,
            "apptPool_Id": 0,
            "apptSlotSchedule_Id": 0,
            "slotScheduleTimeSlotRule_Id": 0,
            "associatedPools": "string",
            "container_Num": "string",
            "apptType_Cd": "string",
            "apptType_Dsc": "string",
            "tradeType": "string",
            "cargoRef_Num": "string",
            "errSeverity_Ind": 0,
            "overallSeverity_Ind": 0,
            "cancelBy": "string",
            "createUser_Id": 0,
            "vessel_Nm": "string",
            "voy_Num": "string",
            "dual_Flg": "string",
            "isDualTransactionOverrideCapacity": true,
            "dualOverrideCapacity_Flg": "string",
            "create_DtTm": "2019-08-24T14:15:22Z",
            "lastModify_DtTm": "2019-08-24T14:15:22Z",
            "apptTosStatus": "string",
            "terminalStatusCd": "string",
            "timeSlotMandatory": true,
            "terminalStatusDesc": "string",
            "externalApptRef_Nbr": "string",
            "isHaz": true,
            "isHaz_Old": true,
            "isReefer_Old": true,
            "isReefer": true,
            "isOD_Old": true,
            "isOD": true,
            "isOwnChs": true,
            "seal1_Num": "string",
            "seal2_Num": "string",
            "seal3_Num": "string",
            "seal4_Num": "string",
            "seal5_Num": "string",
            "seal6_Num": "string",
            "seal7_Num": "string",
            "seal8_Num": "string",
            "specialHandleInstr": "string",
            "apptStatus_Cd": "string",
            "tosApptStatus": "string",
            "apptStatus_Dsc": "string",
            "shippingLine_Cd": "string",
            "shippingLine_Nm": "string",
            "ship_Cd": "string",
            "pod": "string",
            "pdl": "string",
            "remarks": "string",
            "cancelByUser_Id": 0,
            "gateApptCon_Id": 0,
            "con_Num": "string",
            "chassis": "string",
            "chassis_Num": "string",
            "conChkDigit": "string",
            "container_Len": 0,
            "conPrefix_Cd": "string",
            "shippingLine_Id": 0,
            "truckVisit_Id": 0,
            "piN_Num": "string",
            "genset_Num": "string",
            "sChassisWeight": "string",
            "specialInst": "string",
            "chassisSzTyp": "string",
            "move_Request_Identifier": "d9e28b3b-40f2-413f-a882-db988b07d988",
            "messages": [
              {
                "messageid": "string",
                "messageseverity": 0,
                "messagetext": "string",
                "messagedetail": "string",
                "messageservicecd": "string"
              }
            ],
            "mode": "string",
            "apptSlotScheduleDetails_Id": 0,
            "availability": null,
            "bookingEDOState": {
              "bookingEDO_Num": "string",
              "truckingCompany_SCAC": "string",
              "totalOrdered_Qty": 0,
              "diff_Flg": "string",
              "equipmentSzTypeCd": "string",
              "ecpIdentifier": "4c60667b-2aa8-4157-858e-3af1253268cd",
              "conPrefix_Cd": "string",
              "con_Num": "string",
              "conChkDigit": "string",
              "blockType_Cd": "string",
              "bookingEdoType_Cd": "string",
              "shippingLine_SCAC": "string",
              "isHaz": true,
              "isOD": true,
              "isReefer": true,
              "usdaInspectionRequired_Flg": true,
              "fumigationReqd_Flg": true,
              "noSubstitution_Flg": true,
              "cutoffOverride_Flg": true,
              "containerGroup_Cd": "string",
              "truckerPool_Cd": "string",
              "dispatchStart_DtTm": "2019-08-24T14:15:22Z",
              "dispatchEnd_DtTm": "2019-08-24T14:15:22Z",
              "cargoCutOff_DtTm": "2019-08-24T14:15:22Z",
              "beginRcvd_DtTm": "2019-08-24T14:15:22Z",
              "reeferCutoff_DtTm": "2019-08-24T14:15:22Z",
              "hazmatCutoff_DtTm": "2019-08-24T14:15:22Z",
              "odCutoff_DtTm": "2019-08-24T14:15:22Z",
              "dep_Dt": "2019-08-24T14:15:22Z",
              "utcTerminalLastModified_DtTm": "2019-08-24T14:15:22Z"
            },
            "initialCTEU": 0,
            "isoList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "initialSS_Id": 0,
            "initialSSD_Id": 0,
            "preExist": true,
            "intialBookingEDO_Num": "string",
            "oldContainer_Num": "string",
            "moveIdentifier": "2e2c4e66-0405-4f43-8977-753fdc9af262",
            "newMoveIdentifier": "51c2b32e-96fe-4ab5-9cd1-c327e5db4731",
            "isRebookAllowed": true,
            "isRebookApplied": true,
            "userAction": "string",
            "oldPIN_Num": "string",
            "offdkCarrTpInd": true,
            "specialHandlingInstructions": [
              {
                "key": "string",
                "value": null
              }
            ],
            "isCheckIn": true,
            "ref_Type": "string",
            "sVgm_Weight": "string",
            "uom": "string",
            "sizeTypeList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "preAdviceFlag": true,
            "blockType_Cd": "string",
            "billofLadingNumber": "string",
            "isNextGenPregateWebCall": true,
            "lloyds_Num": "string",
            "scaC_CD": "string",
            "truckingCompany_Nm": "string",
            "visibilityEndPoint": "string",
            "scacless": "string"
          }
        ],
        "generalMessages": [
          {
            "messageid": "string",
            "messageseverity": 0,
            "messagetext": "string",
            "messagedetail": "string"
          }
        ],
        "isDisplayFeeCat": true,
        "claimFeesCat": [
          {
            "feeCat": "string",
            "isMandatory": true,
            "isChecked": true
          }
        ],
        "allowFeePayments": true,
        "feeItems": [
          {
            "tariff_Id": 0,
            "mtO_Id": 0,
            "tariffFee_Id": 0,
            "terminalFee_Cd": 0,
            "fee_Id": 0,
            "fee_Cd": "string",
            "fee_Dsc": "string",
            "fee_Amount": 0.1,
            "matchWeight": 0,
            "moveType": "string",
            "feeExemption": true,
            "tempMove_Id": 0,
            "reschDisp": "string",
            "gateApptReschDisp": 0
          }
        ],
        "addToCartFeeCodes": [
          "string"
        ],
        "availableTerminalList": [
          {
            "text": "string",
            "value": null
          }
        ],
        "scacless": true
      }
    ],
    "ruleStage": "string"
  }'

Responses

OK

Bodyapplication/json
visitsobject(IndexedClientVisits)
slotsArray of objects or null(Slots)
Response
application/json
{ "visits": { "indexedClientVisitRequests": [] }, "slots": [ {} ] }

/api/External/GetSlots

Request

Bodyapplication/json
visitsArray of objects or null(ClientVisit)
ruleStagestring or null
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/GetSlots \
  -H 'Content-Type: application/json' \
  -d '{
    "visits": [
      {
        "action": "string",
        "activeTerminal": "string",
        "associatedCompany": 0,
        "associatedCompanyName": "string",
        "truckingCompany_Uid": "string",
        "editVisibility": [
          0
        ],
        "selectedSlot": {
          "text": "string",
          "value": null
        },
        "visit": {
          "visitUIId": 0,
          "truckGroup_UId": "521948b3-f6c8-4697-8fd8-89a4254571cb",
          "truckGroup_Name": "string",
          "mtO_Id": 0,
          "mtoDisplay_Cd": "string",
          "truckVisit_Id": 0,
          "truckvisitFeeResponsibleParty_Id": 0,
          "responsiblePartyCompany_Uid": "string",
          "claimAllFees_Flg": "string",
          "visitDisplay_Nm": "string",
          "truckPlate_Num": "string",
          "rfiD_Cd": "string",
          "pool_Cd": "string",
          "apptPool_Id": 0,
          "apptSlotSchedule_Id": 0,
          "request_Identifier": "537ec0e0-4eef-431c-b124-258dc4d8e079",
          "request_Source": "string",
          "request_Source_Identifier": "string",
          "visitMoveDate": "string",
          "trucker_FirstName": "string",
          "messages": [
            {
              "messageid": "string",
              "messageseverity": 0,
              "messagetext": "string",
              "messagedetail": "string",
              "messageservicecd": "string"
            }
          ],
          "createUser_Id": 0,
          "create_DtTm": "2019-08-24T14:15:22Z",
          "initialSS_Id": 0,
          "userAction": "string",
          "visitBusn_Dt": "2019-08-24T14:15:22Z",
          "visitFrom_Tm": "2019-08-24T14:15:22Z",
          "visitTo_Tm": "2019-08-24T14:15:22Z",
          "visitFrom_DtTm": "2019-08-24T14:15:22Z",
          "visitTo_DtTm": "2019-08-24T14:15:22Z",
          "company_Id": 0,
          "company_Uid": "string",
          "isRecommendedSlot": true
        },
        "moves": [
          {
            "moveUIId": 0,
            "mtoDisplay_Cd": "string",
            "mtO_Id": 0,
            "con_Cd": "string",
            "equipmentIso_Cd": "string",
            "gateAppt_Id": 0,
            "apptPool_Id": 0,
            "apptSlotSchedule_Id": 0,
            "slotScheduleTimeSlotRule_Id": 0,
            "associatedPools": "string",
            "container_Num": "string",
            "apptType_Cd": "string",
            "apptType_Dsc": "string",
            "tradeType": "string",
            "cargoRef_Num": "string",
            "errSeverity_Ind": 0,
            "overallSeverity_Ind": 0,
            "cancelBy": "string",
            "createUser_Id": 0,
            "vessel_Nm": "string",
            "voy_Num": "string",
            "dual_Flg": "string",
            "isDualTransactionOverrideCapacity": true,
            "dualOverrideCapacity_Flg": "string",
            "create_DtTm": "2019-08-24T14:15:22Z",
            "lastModify_DtTm": "2019-08-24T14:15:22Z",
            "apptTosStatus": "string",
            "terminalStatusCd": "string",
            "timeSlotMandatory": true,
            "terminalStatusDesc": "string",
            "externalApptRef_Nbr": "string",
            "isHaz": true,
            "isHaz_Old": true,
            "isReefer_Old": true,
            "isReefer": true,
            "isOD_Old": true,
            "isOD": true,
            "isOwnChs": true,
            "seal1_Num": "string",
            "seal2_Num": "string",
            "seal3_Num": "string",
            "seal4_Num": "string",
            "seal5_Num": "string",
            "seal6_Num": "string",
            "seal7_Num": "string",
            "seal8_Num": "string",
            "specialHandleInstr": "string",
            "apptStatus_Cd": "string",
            "tosApptStatus": "string",
            "apptStatus_Dsc": "string",
            "shippingLine_Cd": "string",
            "shippingLine_Nm": "string",
            "ship_Cd": "string",
            "pod": "string",
            "pdl": "string",
            "remarks": "string",
            "cancelByUser_Id": 0,
            "gateApptCon_Id": 0,
            "con_Num": "string",
            "chassis": "string",
            "chassis_Num": "string",
            "conChkDigit": "string",
            "container_Len": 0,
            "conPrefix_Cd": "string",
            "shippingLine_Id": 0,
            "truckVisit_Id": 0,
            "piN_Num": "string",
            "genset_Num": "string",
            "sChassisWeight": "string",
            "specialInst": "string",
            "chassisSzTyp": "string",
            "move_Request_Identifier": "d9e28b3b-40f2-413f-a882-db988b07d988",
            "messages": [
              {
                "messageid": "string",
                "messageseverity": 0,
                "messagetext": "string",
                "messagedetail": "string",
                "messageservicecd": "string"
              }
            ],
            "mode": "string",
            "apptSlotScheduleDetails_Id": 0,
            "availability": null,
            "bookingEDOState": {
              "bookingEDO_Num": "string",
              "truckingCompany_SCAC": "string",
              "totalOrdered_Qty": 0,
              "diff_Flg": "string",
              "equipmentSzTypeCd": "string",
              "ecpIdentifier": "4c60667b-2aa8-4157-858e-3af1253268cd",
              "conPrefix_Cd": "string",
              "con_Num": "string",
              "conChkDigit": "string",
              "blockType_Cd": "string",
              "bookingEdoType_Cd": "string",
              "shippingLine_SCAC": "string",
              "isHaz": true,
              "isOD": true,
              "isReefer": true,
              "usdaInspectionRequired_Flg": true,
              "fumigationReqd_Flg": true,
              "noSubstitution_Flg": true,
              "cutoffOverride_Flg": true,
              "containerGroup_Cd": "string",
              "truckerPool_Cd": "string",
              "dispatchStart_DtTm": "2019-08-24T14:15:22Z",
              "dispatchEnd_DtTm": "2019-08-24T14:15:22Z",
              "cargoCutOff_DtTm": "2019-08-24T14:15:22Z",
              "beginRcvd_DtTm": "2019-08-24T14:15:22Z",
              "reeferCutoff_DtTm": "2019-08-24T14:15:22Z",
              "hazmatCutoff_DtTm": "2019-08-24T14:15:22Z",
              "odCutoff_DtTm": "2019-08-24T14:15:22Z",
              "dep_Dt": "2019-08-24T14:15:22Z",
              "utcTerminalLastModified_DtTm": "2019-08-24T14:15:22Z"
            },
            "initialCTEU": 0,
            "isoList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "initialSS_Id": 0,
            "initialSSD_Id": 0,
            "preExist": true,
            "intialBookingEDO_Num": "string",
            "oldContainer_Num": "string",
            "moveIdentifier": "2e2c4e66-0405-4f43-8977-753fdc9af262",
            "newMoveIdentifier": "51c2b32e-96fe-4ab5-9cd1-c327e5db4731",
            "isRebookAllowed": true,
            "isRebookApplied": true,
            "userAction": "string",
            "oldPIN_Num": "string",
            "offdkCarrTpInd": true,
            "specialHandlingInstructions": [
              {
                "key": "string",
                "value": null
              }
            ],
            "isCheckIn": true,
            "ref_Type": "string",
            "sVgm_Weight": "string",
            "uom": "string",
            "sizeTypeList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "preAdviceFlag": true,
            "blockType_Cd": "string",
            "billofLadingNumber": "string",
            "isNextGenPregateWebCall": true,
            "lloyds_Num": "string",
            "scaC_CD": "string",
            "truckingCompany_Nm": "string",
            "visibilityEndPoint": "string",
            "scacless": "string"
          }
        ],
        "generalMessages": [
          {
            "messageid": "string",
            "messageseverity": 0,
            "messagetext": "string",
            "messagedetail": "string"
          }
        ],
        "isDisplayFeeCat": true,
        "claimFeesCat": [
          {
            "feeCat": "string",
            "isMandatory": true,
            "isChecked": true
          }
        ],
        "allowFeePayments": true,
        "feeItems": [
          {
            "tariff_Id": 0,
            "mtO_Id": 0,
            "tariffFee_Id": 0,
            "terminalFee_Cd": 0,
            "fee_Id": 0,
            "fee_Cd": "string",
            "fee_Dsc": "string",
            "fee_Amount": 0.1,
            "matchWeight": 0,
            "moveType": "string",
            "feeExemption": true,
            "tempMove_Id": 0,
            "reschDisp": "string",
            "gateApptReschDisp": 0
          }
        ],
        "addToCartFeeCodes": [
          "string"
        ],
        "availableTerminalList": [
          {
            "text": "string",
            "value": null
          }
        ],
        "scacless": true
      }
    ],
    "ruleStage": "string"
  }'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

/api/External/CreateUpdateVisits

Request

Bodyapplication/json
indexedClientVisitRequestsArray of objects or null(ClientVisit)
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/CreateUpdateVisits \
  -H 'Content-Type: application/json' \
  -d '{
    "indexedClientVisitRequests": [
      {
        "action": "string",
        "activeTerminal": "string",
        "associatedCompany": 0,
        "associatedCompanyName": "string",
        "truckingCompany_Uid": "string",
        "editVisibility": [
          0
        ],
        "selectedSlot": {
          "text": "string",
          "value": null
        },
        "visit": {
          "visitUIId": 0,
          "truckGroup_UId": "521948b3-f6c8-4697-8fd8-89a4254571cb",
          "truckGroup_Name": "string",
          "mtO_Id": 0,
          "mtoDisplay_Cd": "string",
          "truckVisit_Id": 0,
          "truckvisitFeeResponsibleParty_Id": 0,
          "responsiblePartyCompany_Uid": "string",
          "claimAllFees_Flg": "string",
          "visitDisplay_Nm": "string",
          "truckPlate_Num": "string",
          "rfiD_Cd": "string",
          "pool_Cd": "string",
          "apptPool_Id": 0,
          "apptSlotSchedule_Id": 0,
          "request_Identifier": "537ec0e0-4eef-431c-b124-258dc4d8e079",
          "request_Source": "string",
          "request_Source_Identifier": "string",
          "visitMoveDate": "string",
          "trucker_FirstName": "string",
          "messages": [
            {
              "messageid": "string",
              "messageseverity": 0,
              "messagetext": "string",
              "messagedetail": "string",
              "messageservicecd": "string"
            }
          ],
          "createUser_Id": 0,
          "create_DtTm": "2019-08-24T14:15:22Z",
          "initialSS_Id": 0,
          "userAction": "string",
          "visitBusn_Dt": "2019-08-24T14:15:22Z",
          "visitFrom_Tm": "2019-08-24T14:15:22Z",
          "visitTo_Tm": "2019-08-24T14:15:22Z",
          "visitFrom_DtTm": "2019-08-24T14:15:22Z",
          "visitTo_DtTm": "2019-08-24T14:15:22Z",
          "company_Id": 0,
          "company_Uid": "string",
          "isRecommendedSlot": true
        },
        "moves": [
          {
            "moveUIId": 0,
            "mtoDisplay_Cd": "string",
            "mtO_Id": 0,
            "con_Cd": "string",
            "equipmentIso_Cd": "string",
            "gateAppt_Id": 0,
            "apptPool_Id": 0,
            "apptSlotSchedule_Id": 0,
            "slotScheduleTimeSlotRule_Id": 0,
            "associatedPools": "string",
            "container_Num": "string",
            "apptType_Cd": "string",
            "apptType_Dsc": "string",
            "tradeType": "string",
            "cargoRef_Num": "string",
            "errSeverity_Ind": 0,
            "overallSeverity_Ind": 0,
            "cancelBy": "string",
            "createUser_Id": 0,
            "vessel_Nm": "string",
            "voy_Num": "string",
            "dual_Flg": "string",
            "isDualTransactionOverrideCapacity": true,
            "dualOverrideCapacity_Flg": "string",
            "create_DtTm": "2019-08-24T14:15:22Z",
            "lastModify_DtTm": "2019-08-24T14:15:22Z",
            "apptTosStatus": "string",
            "terminalStatusCd": "string",
            "timeSlotMandatory": true,
            "terminalStatusDesc": "string",
            "externalApptRef_Nbr": "string",
            "isHaz": true,
            "isHaz_Old": true,
            "isReefer_Old": true,
            "isReefer": true,
            "isOD_Old": true,
            "isOD": true,
            "isOwnChs": true,
            "seal1_Num": "string",
            "seal2_Num": "string",
            "seal3_Num": "string",
            "seal4_Num": "string",
            "seal5_Num": "string",
            "seal6_Num": "string",
            "seal7_Num": "string",
            "seal8_Num": "string",
            "specialHandleInstr": "string",
            "apptStatus_Cd": "string",
            "tosApptStatus": "string",
            "apptStatus_Dsc": "string",
            "shippingLine_Cd": "string",
            "shippingLine_Nm": "string",
            "ship_Cd": "string",
            "pod": "string",
            "pdl": "string",
            "remarks": "string",
            "cancelByUser_Id": 0,
            "gateApptCon_Id": 0,
            "con_Num": "string",
            "chassis": "string",
            "chassis_Num": "string",
            "conChkDigit": "string",
            "container_Len": 0,
            "conPrefix_Cd": "string",
            "shippingLine_Id": 0,
            "truckVisit_Id": 0,
            "piN_Num": "string",
            "genset_Num": "string",
            "sChassisWeight": "string",
            "specialInst": "string",
            "chassisSzTyp": "string",
            "move_Request_Identifier": "d9e28b3b-40f2-413f-a882-db988b07d988",
            "messages": [
              {
                "messageid": "string",
                "messageseverity": 0,
                "messagetext": "string",
                "messagedetail": "string",
                "messageservicecd": "string"
              }
            ],
            "mode": "string",
            "apptSlotScheduleDetails_Id": 0,
            "availability": null,
            "bookingEDOState": {
              "bookingEDO_Num": "string",
              "truckingCompany_SCAC": "string",
              "totalOrdered_Qty": 0,
              "diff_Flg": "string",
              "equipmentSzTypeCd": "string",
              "ecpIdentifier": "4c60667b-2aa8-4157-858e-3af1253268cd",
              "conPrefix_Cd": "string",
              "con_Num": "string",
              "conChkDigit": "string",
              "blockType_Cd": "string",
              "bookingEdoType_Cd": "string",
              "shippingLine_SCAC": "string",
              "isHaz": true,
              "isOD": true,
              "isReefer": true,
              "usdaInspectionRequired_Flg": true,
              "fumigationReqd_Flg": true,
              "noSubstitution_Flg": true,
              "cutoffOverride_Flg": true,
              "containerGroup_Cd": "string",
              "truckerPool_Cd": "string",
              "dispatchStart_DtTm": "2019-08-24T14:15:22Z",
              "dispatchEnd_DtTm": "2019-08-24T14:15:22Z",
              "cargoCutOff_DtTm": "2019-08-24T14:15:22Z",
              "beginRcvd_DtTm": "2019-08-24T14:15:22Z",
              "reeferCutoff_DtTm": "2019-08-24T14:15:22Z",
              "hazmatCutoff_DtTm": "2019-08-24T14:15:22Z",
              "odCutoff_DtTm": "2019-08-24T14:15:22Z",
              "dep_Dt": "2019-08-24T14:15:22Z",
              "utcTerminalLastModified_DtTm": "2019-08-24T14:15:22Z"
            },
            "initialCTEU": 0,
            "isoList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "initialSS_Id": 0,
            "initialSSD_Id": 0,
            "preExist": true,
            "intialBookingEDO_Num": "string",
            "oldContainer_Num": "string",
            "moveIdentifier": "2e2c4e66-0405-4f43-8977-753fdc9af262",
            "newMoveIdentifier": "51c2b32e-96fe-4ab5-9cd1-c327e5db4731",
            "isRebookAllowed": true,
            "isRebookApplied": true,
            "userAction": "string",
            "oldPIN_Num": "string",
            "offdkCarrTpInd": true,
            "specialHandlingInstructions": [
              {
                "key": "string",
                "value": null
              }
            ],
            "isCheckIn": true,
            "ref_Type": "string",
            "sVgm_Weight": "string",
            "uom": "string",
            "sizeTypeList": [
              {
                "text": "string",
                "value": null
              }
            ],
            "preAdviceFlag": true,
            "blockType_Cd": "string",
            "billofLadingNumber": "string",
            "isNextGenPregateWebCall": true,
            "lloyds_Num": "string",
            "scaC_CD": "string",
            "truckingCompany_Nm": "string",
            "visibilityEndPoint": "string",
            "scacless": "string"
          }
        ],
        "generalMessages": [
          {
            "messageid": "string",
            "messageseverity": 0,
            "messagetext": "string",
            "messagedetail": "string"
          }
        ],
        "isDisplayFeeCat": true,
        "claimFeesCat": [
          {
            "feeCat": "string",
            "isMandatory": true,
            "isChecked": true
          }
        ],
        "allowFeePayments": true,
        "feeItems": [
          {
            "tariff_Id": 0,
            "mtO_Id": 0,
            "tariffFee_Id": 0,
            "terminalFee_Cd": 0,
            "fee_Id": 0,
            "fee_Cd": "string",
            "fee_Dsc": "string",
            "fee_Amount": 0.1,
            "matchWeight": 0,
            "moveType": "string",
            "feeExemption": true,
            "tempMove_Id": 0,
            "reschDisp": "string",
            "gateApptReschDisp": 0
          }
        ],
        "addToCartFeeCodes": [
          "string"
        ],
        "availableTerminalList": [
          {
            "text": "string",
            "value": null
          }
        ],
        "scacless": true
      }
    ]
  }'

Responses

OK

Bodyapplication/json
visitsobject(IndexedClientVisits)
slotsArray of objects or null(Slots)
Response
application/json
{ "visits": { "indexedClientVisitRequests": [] }, "slots": [ {} ] }

/api/External/CancelMove

Request

Bodyapplication/json
gateApptIdListArray of objects or null(ApptRequest)
truckVisitIdListArray of objects or null(ApptRequest)
curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/External/CancelMove \
  -H 'Content-Type: application/json' \
  -d '{
    "gateApptIdList": [
      {
        "id": 0,
        "mtO_Id": 0,
        "mtO_Cd": "string"
      }
    ],
    "truckVisitIdList": [
      {
        "id": 0,
        "mtO_Id": 0,
        "mtO_Cd": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
todayArray of objects or null(TimeSlot)
tomorrowArray of objects or null(TimeSlot)
Response
application/json
{ "today": [ {} ], "tomorrow": [ {} ] }

Pregate

Operations