DataArea

Is where the information that the BOD message carries is provided, in this case GetCarrierRoute. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (CarrierRoute).

Element information

Content

• Sequence [1..1]
  1. Get [1..1]    The Get verb is to communicate to a business software component a request for an existing piece or pieces of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across the nouns it is paired with.The Get is designed to retrieval of information by using that information's primary retrieval field, or key field. The Get verb may also be used to request several documents at once. Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned.
  2. CarrierRoute [1..*]    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.

Attributes

None

Used in

• Type GetCarrierRouteType (Element GetCarrierRoute)

Sample instance

<DataArea>
   <Get>
      <Expression>token</Expression>
   </Get>
   <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>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </DocumentReference>
      <Attachment>
         <ID/>
         <IDSet>...
         </IDSet>
         <EmbeddedDataBinaryObject/>
         <URI>normalizedString</URI>
         <ISBN>normalizedString</ISBN>
         <FileName/>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <FileTypeCode>normalizedString</FileTypeCode>
         <FileSizeQuantity>1.0</FileSizeQuantity>
         <Title/>
         <Extension>.......................................
         </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>...
         </IDSet>
         <IncotermsCode>token</IncotermsCode>
         <PlaceOfOwnershipTransferLocation>...
         </PlaceOfOwnershipTransferLocation>
         <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode>
         <FreightTermCode>token</FreightTermCode>
         <Description/>
         <Note/>
         <FreightChargeGeographicLocationIndicator>true</FreightChargeGeographicLocationIndicator>
         <Extension>.......................................
         </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>...
         </IDSet>
         <ContainerID>normalizedString</ContainerID>
         <RFID>normalizedString</RFID>
         <SealID>normalizedString</SealID>
         <ContainerGroupID>normalizedString</ContainerGroupID>
         <DocumentReference>...
         </DocumentReference>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <PackingMaterial>...
         </PackingMaterial>
         <ShippingMaterial>...
         </ShippingMaterial>
         <Quantity/>
         <Extension>.......................................
         </Extension>
      </Container>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <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>
      <RouteStop>
         <ID/>
         <IDSet>...
         </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>...
         </HazardousMaterial>
         <Charge>...
         </Charge>
         <Party>...
         </Party>
         <DocumentReference>...
         </DocumentReference>
         <StopDetail>...
         </StopDetail>
         <Extension>.......................................
         </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>
</DataArea>