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

Recommended Reading:

Definitive XML Schema

 

Web Service Contract Design and Versioning for SOA

 

Advanced XML Applications

 

CancelShipmentUnit

The purpose of the CancelShipmentUnit is to enable an application to provide a ShipmentUnit information from another business application module in order for that module to perform the task at hand..

The CancelShipmentUnit is typically published from the business application that is is requesting that the master or owner of the ShipmentUnit information to Cancel the contained update. This may also occur across enterprises.

The respons to the CancelShipmentUnit is the AcknowledgeShipmentUnit to indicate success or failure. If the receiving system needs to make Cancels to the ShipmentUnit then the CancelShipmentUnit can be used a coresponding RespondShipmentUnit accepts the Cancels or indicates additional Cancels.

Element information

Type: CancelShipmentUnitType

Properties: Global, Qualified, ID: oagis-id-9104621229c94ef0984c6b92db4ac291

Content

Attributes

NameOccTypeDescriptionNotes
releaseID [1..1]NormalizedStringTypeOAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on.from type BusinessObjectDocumentType
versionID [0..1]NormalizedStringTypeIndicates the version of the given BOD definition.from type BusinessObjectDocumentType
systemEnvironmentCode [0..1]SystemEnvironmentCodeContentTypeIndicates 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]LanguageCodeContentTypeIndicates the language that the contents of the BOD is in unless otherwise stated.Default value is "en-US". from type BusinessObjectDocumentType

Sample instance

<CancelShipmentUnit 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>
      <Cancel>
         <ActionCriteria>...
         </ActionCriteria>
      </Cancel>
      <ShipmentUnit>
         <ID/>
         <IDSet>...
         </IDSet>
         <TrackingID>normalizedString</TrackingID>
         <ShipUnitSequenceID>normalizedString</ShipUnitSequenceID>
         <ShipUnitTotalID>normalizedString</ShipUnitTotalID>
         <ContainerGroupID>normalizedString</ContainerGroupID>
         <ContainerID>normalizedString</ContainerID>
         <RFID>normalizedString</RFID>
         <SealID>normalizedString</SealID>
         <Description/>
         <Note/>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <CarrierParty>...
         </CarrierParty>
         <ShipFromParty>...
         </ShipFromParty>
         <ShipToParty>...
         </ShipToParty>
         <DeclaredValueAmount/>
         <ShipmentDateTime></ShipmentDateTime>
         <ContainsHazardousMaterialIndicator>true</ContainsHazardousMaterialIndicator>
         <ExportLicenseRequiredIndicator>true</ExportLicenseRequiredIndicator>
         <ImportLicenseRequiredIndicator>true</ImportLicenseRequiredIndicator>
         <ScheduledDeliveryDateTime></ScheduledDeliveryDateTime>
         <ActualDeliveryDateTime></ActualDeliveryDateTime>
         <SpecialHandlingNote/>
         <Status>...
         </Status>
         <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
         <TareWeightMeasure>1.0</TareWeightMeasure>
         <NetWeightMeasure>1.0</NetWeightMeasure>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <NetVolumeMeasure>1.0</NetVolumeMeasure>
         <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
         <DistributeCharge>...
         </DistributeCharge>
         <EstimatedFreightChargeAmount/>
         <FreightChargeAmount/>
         <SalePriceAmount/>
         <ShipmentTotalAmount/>
         <LoadingDateTime></LoadingDateTime>
         <EstimatedWeightMeasure>1.0</EstimatedWeightMeasure>
         <LoadingWeightMeasure>1.0</LoadingWeightMeasure>
         <Dimensions>...
         </Dimensions>
         <CountryOfOriginCode>token</CountryOfOriginCode>
         <DestinationCountryCode>token</DestinationCountryCode>
         <HazardousMaterialCodes>...
         </HazardousMaterialCodes>
         <TransportationMethodCode>normalizedString</TransportationMethodCode>
         <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode>
         <PointOfStagingCode>normalizedString</PointOfStagingCode>
         <TransportationTerm>...
         </TransportationTerm>
         <TransportStep>...
         </TransportStep>
         <ExportLicense>...
         </ExportLicense>
         <ShipToLocation>...
         </ShipToLocation>
         <PackingMaterial>...
         </PackingMaterial>
         <ShippingMaterial>...
         </ShippingMaterial>
         <ShipmentUnitContainer>...
         </ShipmentUnitContainer>
         <ShipmentUnitItem>...
         </ShipmentUnitItem>
         <ContainerQuantity>1.0</ContainerQuantity>
         <Extension>.......................................
         </Extension>
      </ShipmentUnit>
   </DataArea>
</CancelShipmentUnit>

Site developed and hosted by Datypic, Inc.

Please report errors or comments about this site to pwalmsley@datypic.com