Schema Central > OAGIS® 10 > Common.xsd > CarrierRoute
Advanced search
Need XML Help?

Recommended Reading:

Definitive XML Schema

 

Web Service Contract Design and Versioning for SOA

 

Advanced XML Applications

 

CarrierRoute

Describes a scheduled journey that a particular goods transportation service provider (freight carrier) is requested to perform on the behalf of a shipper, customer or other transportation corrdinator. The journey may contain one or more stops.

There are many possible business applications in several environments that may use this capability.

A CarrierRoute is typically generated by a transportation planning system to coordinate and optimize the movement of many goods shipment to reduce overall freight cost, improve overall delivery schedules, and ensure that a carrier's equipment is utilized efficiently.

Other business systems typically interested in a CarrierRoute document include supply chain execution, supply chain visibility, warehouse management, and transportaion management systems.

Element information

Type: CarrierRouteType

Properties: Global, Qualified, ID: oagis-id-fba85dc216c64363a2bddf35f5a267a5

Content

Attributes

Name Occ Type Description Notes
typeCode [0..1] CodeType_1E7368 from type CarrierRouteBaseType
actionCode [0..1] ActionCodeContentType from type CarrierRouteBaseType

Used in

Sample instance

<CarrierRoute>
   <ID/>
   <RevisionID>normalizedString</RevisionID>
   <VariationID>normalizedString</VariationID>
   <DocumentIDSet>
      <ID/>
   </DocumentIDSet>
   <LastModificationDateTime></LastModificationDateTime>
   <DocumentDateTime></DocumentDateTime>
   <Description/>
   <Note/>
   <DocumentReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </DocumentReference>
   <Attachment>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <EmbeddedDataBinaryObject/>
      <URI>normalizedString</URI>
      <ISBN>normalizedString</ISBN>
      <FileName/>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <FileTypeCode>normalizedString</FileTypeCode>
      <FileSizeQuantity>1.0</FileSizeQuantity>
      <Title/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Attachment>
   <TrackingID>normalizedString</TrackingID>
   <ActualShipDateTime></ActualShipDateTime>
   <ScheduledDeliveryDateTime></ScheduledDeliveryDateTime>
   <ActualDeliveryDateTime></ActualDeliveryDateTime>
   <RequiredDeliveryDateTime></RequiredDeliveryDateTime>
   <PromisedDeliveryDateTime></PromisedDeliveryDateTime>
   <LoadingDateTime></LoadingDateTime>
   <EarliestShipDateTime></EarliestShipDateTime>
   <PromisedShipDateTime></PromisedShipDateTime>
   <ScheduledShipDateTime></ScheduledShipDateTime>
   <PointOfLoadingCode>normalizedString</PointOfLoadingCode>
   <PointOfShipmentCode>normalizedString</PointOfShipmentCode>
   <PointOfStagingCode>normalizedString</PointOfStagingCode>
   <TransportationMethodCode>normalizedString</TransportationMethodCode>
   <TransportationTerm>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <IncotermsCode>token</IncotermsCode>
      <PlaceOfOwnershipTransferLocation>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </PlaceOfOwnershipTransferLocation>
      <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode>
      <FreightTermCode>token</FreightTermCode>
      <Description/>
      <Note/>
      <FreightChargeGeographicLocationIndicator>true</FreightChargeGeographicLocationIndicator>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </TransportationTerm>
   <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
   <TareWeightMeasure>1.0</TareWeightMeasure>
   <NetWeightMeasure>1.0</NetWeightMeasure>
   <GrossWeightMeasure>1.0</GrossWeightMeasure>
   <NetVolumeMeasure>1.0</NetVolumeMeasure>
   <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
   <Container>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <ContainerID>normalizedString</ContainerID>
      <RFID>normalizedString</RFID>
      <SealID>normalizedString</SealID>
      <ContainerGroupID>normalizedString</ContainerGroupID>
      <DocumentReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </DocumentReference>
      <GrossWeightMeasure>1.0</GrossWeightMeasure>
      <PackingMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </PackingMaterial>
      <ShippingMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </ShippingMaterial>
      <Quantity/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Container>
   <Status>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Code/>
      <Description/>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason/>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Status>
   <Charge>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <BasisAmount/>
      <BasisQuantity>1.0</BasisQuantity>
      <Description/>
      <Amount/>
      <Calculation>
         <ID/>
         <IDSet>...
         </IDSet>
         <Formula/>
         <RateNumber>1.0</RateNumber>
         <Description/>
         <ApplicableTimePeriod>..................
         </ApplicableTimePeriod>
         <Extension>.......................................
         </Extension>
      </Calculation>
      <ReasonCode>normalizedString</ReasonCode>
      <CurrencyExchangeRate>
         <ID/>
         <IDSet>...
         </IDSet>
         <SourceCurrencyCode>token</SourceCurrencyCode>
         <SourceUnitBaseNumber>1.0</SourceUnitBaseNumber>
         <TargetCurrencyCode>token</TargetCurrencyCode>
         <TargetUnitBaseNumber>1.0</TargetUnitBaseNumber>
         <RateNumber>1.0</RateNumber>
         <SetDateTime></SetDateTime>
         <SourceID>normalizedString</SourceID>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </CurrencyExchangeRate>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </TimePeriod>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Charge>
   <Party>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Party>
   <RouteStop>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <TrackingID>normalizedString</TrackingID>
      <ContainerID>normalizedString</ContainerID>
      <Description/>
      <Note/>
      <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
      <TareWeightMeasure>1.0</TareWeightMeasure>
      <NetWeightMeasure>1.0</NetWeightMeasure>
      <GrossWeightMeasure>1.0</GrossWeightMeasure>
      <NetVolumeMeasure>1.0</NetVolumeMeasure>
      <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
      <HazardousMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <MFAGID>normalizedString</MFAGID>
         <TechnicalName/>
         <PlacardEndorsement/>
         <PlacardNotation/>
         <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode>
         <ToxicityZoneCode>normalizedString</ToxicityZoneCode>
         <Temperature/>
         <FlashpointTemperature>1.0</FlashpointTemperature>
         <PrimaryEntryRoute/>
         <Description/>
         <EmergencyContact>...
         </EmergencyContact>
         <HazardousClass/>
         <PackingGroup/>
         <Extension>.......................................
         </Extension>
      </HazardousMaterial>
      <Charge>
         <ID/>
         <IDSet>...
         </IDSet>
         <BasisAmount/>
         <BasisQuantity>1.0</BasisQuantity>
         <Description/>
         <Amount/>
         <Calculation>...
         </Calculation>
         <ReasonCode>normalizedString</ReasonCode>
         <CurrencyExchangeRate>...
         </CurrencyExchangeRate>
         <TimePeriod>..................
         </TimePeriod>
         <Extension>.......................................
         </Extension>
      </Charge>
      <Party>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </Party>
      <DocumentReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </DocumentReference>
      <StopDetail>
         <ID/>
         <IDSet>...
         </IDSet>
         <ContainerID>normalizedString</ContainerID>
         <Description/>
         <Note/>
         <TrackingID>normalizedString</TrackingID>
         <ShipToParty>...
         </ShipToParty>
         <Party>...
         </Party>
         <ShipUnitReference>...
         </ShipUnitReference>
         <ShipmentReference>...
         </ShipmentReference>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <BillOfLadingReference>...
         </BillOfLadingReference>
         <Extension>.......................................
         </Extension>
      </StopDetail>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </RouteStop>
   <Extension>
      <AnyExtension>
         <!--any element-->
      </AnyExtension>
      <Amount/>
      <Code/>
      <DateTime></DateTime>
      <ID/>
      <Indicator>true</Indicator>
      <Measure/>
      <Name/>
      <Number>1.0</Number>
      <Quantity/>
      <Text/>
      <Time></Time>
      <ValueText>string</ValueText>
   </Extension>
</CarrierRoute>

Site developed and hosted by Datypic, Inc.

Please report errors or comments about this site to contrib@functx.com