Documentation for Open Applications Group (OAGIS)
Definition Type: ComplexType
Name: OnlineSessionType
Namespace: http://www.openapplications.org/oagis/9
Containing Schema: OnlineSession.xsd
Abstract
Documentation:
This includes all the parameters necessary to request and identify a session between two applications. Information within this component includes information like the userid, account, usergroup, URLs to which the reply/ cart should be redirected and so on. This also includes the ReturnURL tag to identify the result URL that is returned by the target system as a result of processing the Request.
Collapse XSD Schema Diagram:
Drilldown into UserArea in schema fields_xsd Drilldown into SearchTerm in schema onlinesession_xsd Drilldown into CatalogParty in schema components_xsd Drilldown into RecipientParty in schema components_xsd Drilldown into OriginatorParty in schema components_xsd Drilldown into Note in schema fields_xsd Drilldown into Description in schema fields_xsd Drilldown into FreeFormTextGroup in schema meta_xsd Drilldown into RequestLanguageCode in schema fields_xsd Drilldown into ReturnURL in schema fields_xsd Drilldown into RedirectURL in schema fields_xsd Drilldown into ReplyURL in schema fields_xsd Drilldown into ResponseDateTime in schema fields_xsd Drilldown into RequestDateTime in schema fields_xsd Drilldown into User in schema components_xsd Drilldown into SessionID in schema fields_xsdXSD Diagram of OnlineSessionType in schema onlinesession_xsd (Open Applications Group (OAGIS))
Collapse XSD Schema Code: 
<xsd:complexType name="OnlineSessionType">
    <xsd:annotation>
        <xsd:documentation source="http://www.openapplications.org/oagis/9">This includes all the parameters necessary to request and identify a session between two applications.  Information within this component includes information like the userid, account, usergroup, URLs to which the reply/ cart should be redirected and so on.

This also includes the ReturnURL tag to identify the result URL that is returned by the target system as a result of processing the Request.</xsd:documentation>
    </xsd:annotation>
    <xsd:sequence>
        <xsd:element ref="SessionID" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">The SessionId uniquely identifies the session that makes the Request</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="User" minOccurs="0" />
        <xsd:element ref="RequestDateTime" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">This is the DateTime at which the Request for the OnlineSession is initiated by the Requesting application</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="ResponseDateTime" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">This is the DateTime at which the Response for the OnlineSession is generated by the Target application</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="ReplyURL" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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.</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="RedirectURL" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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. </xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="ReturnURL" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:element ref="RequestLanguageCode" minOccurs="0">
            <xsd:annotation>
                <xsd:documentation source="http://www.openapplications.org/oagis/9">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</xsd:documentation>
            </xsd:annotation>
        </xsd:element>
        <xsd:group ref="FreeFormTextGroup" />
        <xsd:element ref="OriginatorParty" minOccurs="0" />
        <xsd:element ref="RecipientParty" minOccurs="0" />
        <xsd:element ref="CatalogParty" minOccurs="0" maxOccurs="unbounded" />
        <xsd:element ref="SearchTerm" minOccurs="0" maxOccurs="unbounded" />
        <xsd:element ref="UserArea" minOccurs="0" />
    </xsd:sequence>
</xsd:complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
SessionID nsA:SessionID 0 (1)
User nsA:User 0 (1)
RequestDateTime nsA:RequestDateTime 0 (1)
ResponseDateTime nsA:ResponseDateTime 0 (1)
ReplyURL nsA:ReplyURL 0 (1)
RedirectURL nsA:RedirectURL 0 (1)
ReturnURL nsA:ReturnURL 0 (1)
RequestLanguageCode nsA:RequestLanguageCode 0 (1)
Description nsA:Description 0 unbounded
Note nsA:Note 0 unbounded
OriginatorParty nsA:OriginatorParty 0 (1)
RecipientParty nsA:RecipientParty 0 (1)
CatalogParty nsA:CatalogParty 0 unbounded
SearchTerm nsA:SearchTerm 0 unbounded
UserArea nsA:UserArea 0 (1)
<xs:group> nsA:FreeFormTextGroup (1) (1)
Collapse Derivation Tree:
Collapse References:
nsA:OnlineSession
Documentation for Open Applications Group (OAGIS)

Generated using Liquid Studio - Developer Bundle 21.0.0.0