CarrierRouteReference

Element information

Content

• Sequence [1..1]
  from type DocumentReferenceBaseType
  from group DocumentIDsGroup
  Sequence [0..1]
  1. DocumentID [0..1]    Is the primary document id for the document associated.
  2. AlternateDocumentID [0..*]    Is the alternate document id for the associated document.
  DocumentDateTime [0..1]    The date that document was created within the system of record.
  from group FreeFormTextGroup
  Sequence [0..1]
  1. Description [0..*]    
  2. Note [0..*]    
  StatusCode [0..1]    Is the Code to indicate the status for the Noun or Component in which the Status Component occurs.
  Status [0..*]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  1. OperationReference [0..*]    Is a reference to an associated work-in-process operation.
  2. UserArea [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.

Attributes

None

Used in

• Type ShipmentHeaderBaseType
• Type ReceiveDeliveryHeaderType via extension of ShipmentHeaderBaseType (Element ReceiveDeliveryHeader)
• Type ShipmentHeaderType via extension of ShipmentHeaderBaseType (Element ShipmentHeader)

Sample instance

<CarrierRouteReference>
   <DocumentID>
      <ID>normalizedString</ID>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
   </DocumentID>
   <AlternateDocumentID>
      <ID>normalizedString</ID>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
   </AlternateDocumentID>
   <DocumentDateTime>2000-01-01</DocumentDateTime>
   <Description>string</Description>
   <Note>string</Note>
   <StatusCode>normalizedString</StatusCode>
   <Status>
      <Code>normalizedString</Code>
      <Description>string</Description>
      <EffectiveDateTime>2000-01-01</EffectiveDateTime>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason>string</Reason>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime>2000-01-01</StartDateTime>
         <Duration>P1Y2M3DT10H</Duration>
      </TimePeriod>
      <UserArea>
         <!--any element-->
      </UserArea>
   </Status>
   <OperationReference>
      <DocumentID>
         <ID>normalizedString</ID>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
      </DocumentID>
      <AlternateDocumentID>
         <ID>normalizedString</ID>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
      </AlternateDocumentID>
      <DocumentDateTime>2000-01-01</DocumentDateTime>
      <Description>string</Description>
      <Note>string</Note>
      <StatusCode>normalizedString</StatusCode>
      <Status>
         <Code>normalizedString</Code>
         <Description>string</Description>
         <EffectiveDateTime>2000-01-01</EffectiveDateTime>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason>string</Reason>
         <TimePeriod>...
         </TimePeriod>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Status>
      <GroupName>string</GroupName>
      <SequenceCode>normalizedString</SequenceCode>
      <StepID>normalizedString</StepID>
      <StepType>normalizedString</StepType>
      <UserArea>
         <!--any element-->
      </UserArea>
   </OperationReference>
   <UserArea>
      <!--any element-->
   </UserArea>
</CarrierRouteReference>