ChangeCarrierRoute

The purpose of the ChangeCarrierRoute is to enable an application to request specific Carrier Route information from another business application module.  The response to the ChangeCarrierRoute is the ShowCarrierRoute.

Element information

Namespace: http://www.openapplications.org/oagis/10

Schema document: ChangeCarrierRoute.xsd

Type: ChangeCarrierRouteType

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

Content

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

Attributes

Name	Occ	Type	Description	Notes
releaseID	[1..1]	NormalizedStringType	OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on.	from type BusinessObjectDocumentType
versionID	[0..1]	NormalizedStringType	Indicates the version of the given BOD definition.	from type BusinessObjectDocumentType
systemEnvironmentCode	[0..1]	SystemEnvironmentCodeContentType	Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s).	Default value is "Production". from type BusinessObjectDocumentType
languageCode	[0..1]	LanguageCodeContentType	Indicates the language that the contents of the BOD is in unless otherwise stated.	Default value is "en-US". from type BusinessObjectDocumentType

Sample instance

<ChangeCarrierRoute releaseID="normalizedString">
   <ApplicationArea>
      <Sender>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <TaskID>normalizedString</TaskID>
         <ReferenceID>normalizedString</ReferenceID>
         <ConfirmationCodes>...
         </ConfirmationCodes>
         <AuthorizationID>normalizedString</AuthorizationID>
      </Sender>
      <Receiver>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <ID/>
      </Receiver>
      <CreationDateTime></CreationDateTime>
      <Signature>
         <!--any element-->
      </Signature>
      <ScenarioID>normalizedString</ScenarioID>
      <CorrelationID>normalizedString</CorrelationID>
      <BODID>normalizedString</BODID>
      <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>
   </ApplicationArea>
   <DataArea>
      <Change>
         <ActionCriteria>...
         </ActionCriteria>
      </Change>
      <CarrierRoute>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <LastModificationDateTime></LastModificationDateTime>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </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>...
         </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>...
         </Container>
         <Status>...
         </Status>
         <Charge>...
         </Charge>
         <Party>...
         </Party>
         <RouteStop>...
         </RouteStop>
         <Extension>.......................................
         </Extension>
      </CarrierRoute>
   </DataArea>
</ChangeCarrierRoute>