OnlineSession

Element information

Content

• Sequence [1..1]
  1. SessionID [0..1]    The SessionId uniquely identifies the session that makes the Request
  2. User [0..1]    Identifies the user of a given system.
  3. RequestDateTime [0..1]    This is the DateTime at which the Request for the OnlineSession is initiated by the Requesting application
  4. ResponseDateTime [0..1]    This is the DateTime at which the Response for the OnlineSession is generated by the Target application
  5. ReplyURL [0..1]    The ReplyURL is used to specify a URL that can be used by the provider to post any information collected by the requester in the session. An example of usage of this is to post the contents of a cart created by a buying application user from an external catalog.
  6. RedirectURL [0..1]    The RedirectURL can be used to indicate a URL to which the Requesting application can be re-directed once the session initiated by this connection is completed. The session completion event is not recorded in this transaction.
  7. ReturnURL [0..1]    The ReturnURL element is specified in the Show ECatalogURL by the target application. It contains a URL reference to which the requesting application is pointed. This will not have a value in the Request (Get) Message
  8. RequestLanguageCode [0..1]    The RequestLanguage element can be used by the requesting system to indicate the desired language of the catalog or application to which session will be initiated upon receipt of the Show URL transaction. For instance, application A wishes to ‘punch out’ to external system B’s online Dutch-language catalog. System B supports numerous languages, but will validate the value of the 'RequestLanguage' element and return the appropriate URL to direct application A to the Dutch site
  from group FreeFormTextGroup
  Sequence [0..1]
  1. Description [0..*]    
  2. Note [0..*]    
  9. OriginatorParty [0..1]    Identifies the party that originated the purchase of the goods, service or payment.
  10. RecipientParty [0..1]    Identifies the recipient of the goods or services.
  11. CatalogParty [0..*]    Identifies the party whose catalog is used to purchase the goods or services.
  12. SearchTerm [0..*]    The SEARCHTERM data type contains information that can be used to perform an initial search on the destination’s application. For example, a requester might wish to view a supplier’s catalog but restrict the result set for only ‘ballpoint pens’. The requester would use this data type to perform this initial query.
  13. 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 GetOnlineSessionDataAreaType (Element DataArea)
• Type OAGIS9NounsType (Element OAGIS9Nouns)
• Type ShowOnlineSessionDataAreaType (Element DataArea)

Sample instance

<OnlineSession>
   <SessionID>normalizedString</SessionID>
   <User>
      <ID>normalizedString</ID>
      <GroupID>normalizedString</GroupID>
      <UserAccount>
         <SystemID>normalizedString</SystemID>
         <AccountID>normalizedString</AccountID>
         <AccountType>normalizedString</AccountType>
         <UserAuthorization>...
         </UserAuthorization>
         <UserArea>
            <!--any element-->
         </UserArea>
      </UserAccount>
      <UserArea>
         <!--any element-->
      </UserArea>
   </User>
   <RequestDateTime>2000-01-01</RequestDateTime>
   <ResponseDateTime>2000-01-01</ResponseDateTime>
   <ReplyURL>http://www.example.com/</ReplyURL>
   <RedirectURL>http://www.example.com/</RedirectURL>
   <ReturnURL>http://www.example.com/</ReturnURL>
   <RequestLanguageCode>normalizedString</RequestLanguageCode>
   <Description>string</Description>
   <Note>string</Note>
   <OriginatorParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <UserArea>
         <!--any element-->
      </UserArea>
   </OriginatorParty>
   <RecipientParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <UserArea>
         <!--any element-->
      </UserArea>
   </RecipientParty>
   <CatalogParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <UserArea>
         <!--any element-->
      </UserArea>
   </CatalogParty>
   <SearchTerm>
      <SearchValueText>string</SearchValueText>
      <InclusiveIndicator>true</InclusiveIndicator>
      <ExactMatchIndicator>true</ExactMatchIndicator>
      <Operator>token</Operator>
      <SearchQualifier>token</SearchQualifier>
      <UserArea>
         <!--any element-->
      </UserArea>
   </SearchTerm>
   <UserArea>
      <!--any element-->
   </UserArea>
</OnlineSession>