Skip to main content

sgrRetornaProgramacao

Returns the schedule data posted in the system.

SoapAction

PARAMETERS:

FieldTypeReq.Description
keyaccessstringYesKey returned by the sgrLogin method.
cdpasintegerYesPAS code, returned by the sgrListaPASUsuario method
cdclienteintegerYesCustomer code, returned by the sgrListaEmpresasPASUsuario method.
cdprogramacao*integerYesCode of the program to be consulted.
nrprogramacao*integerYesNumber of the schedule to be consulted.

METHOD RETURN:

*ReturnDataset: If the parameters are correct, the dataset will display two tables:

sgrTB:

FieldTypeDescription
cdProgrammingintProgramming code
nrProgramacaostringProgramming number
cdProductintProduct code
vlWeightdoubleWeight of the load to be transported, in kg or t depending on the unit of measurement configured in [Programming parameters].
vlCubagedoubleCubage of the cargo to be transported, in m³.
vlVolumedoubleVolume of cargo to be transported.
cdCargoTypeintCargo type code.
cdPackingTypeintCargo packing type code.
cdPFJLocalLoadingstringCPF or CNPJ registration number of the loading location.
dtPrevIniCarregDateTimeEstimated date/time for the start of loading.
dtPrevEndLoadDateTimeEstimated date/time for the end of loading.
cdProgrammingTypeintProgramming type code.
dtConfirmationDateTimeDate on which it will be confirmed whether the schedule will take place or not.
cdTranspintCarrier code.
cdVeicTypeintVehicle type code.
cdBodyTypeintBody type code.
cdTranspGroupintCarrier group code.
vlMinimumCapacitydoubleMinimum vehicle capacity.
vlMinimumCubagedoubleMinimum vehicle cubage.
cdOpInclintCode of the operator responsible for including the schedule.
dtInclDatetimeDate of schedule inclusion
flsituacaoIntScheduling status: 0 - NEW, 1 - SCHEDULED, 2 - REFUSED, 3 - TRAVELING, 4 - LOADING, 5 - CLOSED, 6 - CANCELLED, 7 - RESCHEDULED.
cdCliintCustomer code
vlLoadWeightdoubleLoad weight, in kg or t depending on the unit of measurement configured in [Programming parameters].
vlLoadCubagedoubleLoad cubage, in m³.
vlLoadVolumedoubleLoad volume.
cdPFJLocalBaixaintCode of the local of low.
dtRealIniCarregDatetimeActual start date of loading (Arrival).
dtRealEndLoadDatetimeActual end of load date (Exit).
dsDischargeDetailstringSchedule discharge detail.
cdOpDischargeintDischarge user code.
dtBaixastringCPF or CNPJ registration number of the cargo shipper.
cdMotivoCancelaProgstringField for free use by the customer.
dsCancelDetailstringCancellation detail.
cdOpCancelintCode of the operator who canceled the schedule.
dtCancelDatetimeCode of the reason for canceling the schedule.
cdReasonRefusalProgintCode for the reason for refusing the schedule. .
dsRefusalDetailstringRefusal detail.
cdOpRefusalintCode of the operator who refused the schedule.
ddDenialDatetimeDate the schedule was denied.
cdOpAlterintCode of the operator responsible for the last change.
dtAlterDatetimeDate of last change.
cdVeic, cdCarreta1, cdCarreta2intVehicle code.
cdMot1intDriver code
dtAgendamentoDatetimeScheduling date
cdOpScheduleintCode of the operator who made the appointment.
cdShipperintShipper code
nrControleCarga, dsControleProgramacao (1 to 10)stringField for free use by the client. *This field may be mandatory depending on what has been configured for the client.
flSitLocalCarregintService location status
dtLaixaLocalCarregDatetimeCharging location write-off date
dsMotDischargeLocalCarregStringDischarge reason
cdOpLaixaLocalCarregIntCode of the operator who carried out the write-off
dsBookingstringReservation of spaces for cargo on the ship (Square Booking)
dsCtestringCT-e code
cdTipoServicoIntProgramming service type code.
cdContainer (1 to 3)intProgramming container code
cdReservationintVehicle reservation code.
nrSolicColetastringCollection request number.
dsShipstringShip.
nrTripstringTrip number generated
dsDirectionstringDirection.
dsBUstringBU.
dsObsOpenstringObservation Open.
cdObsClosedintObservation Closed.
dsLacresContainerstringDescription
cdRespUnitintResponsible unit
cdReasonCancelScheduleintReason code for canceling the schedule.
dsDetailCancelScheduleStringDescription
cdOpCancelScheduleintCode of the operator who canceled the schedule.
dtCancelScheduledatetimeDate the schedule was canceled.
dtPrevRecalculateddatetimeEstimated date recalculated.
vlDistanciaRestantedoubleRemaining Distance.
vlKmTraveleddoubleKmTraveled.
vlPredictedDistanceintPredicted Distance.
vlProddoubleService Location Product Value.
dsObsstringObservations
vlLat, vlLongdoubleLatitude, Longitude
dtArrivalClidatetimeCustomer arrival date
dtDepartureClidatetimeCustomer departure date

sgrTBDest:

FieldTypeDescription
cdProgramacaoDestinatarioIntCode of the programming recipient.
cdProgramacaointCode of the schedule to which the recipient is linked.
cdProgrammingOperationTypeintProgramming operation type code.
cdPFJLocalDescargaintCode of the unloading location.
dsCliDestinostringProgramming recipient name.
cdCidDestinationintDestination city code.
dtPrevArrivaldatetimeEstimated date of arrival at destination.
cdProductIntProduct to be delivered.
vlProductdoubleValue of the product to be delivered.
nrControlProgramming[1 to 10]stringField for free use by the customer.
cdCliIntCustomer code.
flSitLocalDescargaintStatus of the transit location
dtLaixaLocalDescargadatetimeDate of write-off at the transit location.
dsMotDischargeLocationstringReason for discharging from the transit location
cdOpDischargeLocationIntOperator responsible for the discharge.
flNoteExchangeintThis field indicates whether the document allows invoices to be exchanged (1-Yes, 2-No).
cdDocintDocument code created when the trip was created with Scheduling.
dtPrevDeparturedatetimeExpected date/time for the end of passage at the unloading point.
dtPrevRecalculateddatetimeEstimated date recalculated.
vlDistanceRestantdoubleDistance Remaining.
vlKmTraveleddoubleKmTraveled.
vlPredictedDistancedoublePredicted Distance.
vlLat, vlLongdoubleLatitude, Longitude
dtDepartureClidatetimeExpected date of departure from the transit point
dtArrivalClidatetimeEstimated date of arrival at the transit point
flSituationintSituation: 0 = inactive and 1 = active