OnlineSession
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: OnlineSessionType
Properties: Global, Qualified, ID: oagis-id-1d2ee7e3aec948b89e0b69a5ba5eb021
Content
- Sequence [1..1]
- SessionID [0..1] The SessionID uniquely identifies a client session with a server e.g. a user logging in to an application or a buyer session with a marketplace
- User [0..1] Identifies the user of a given system.
- RequestDateTime [0..1] This is the datetime at which a request is made for something e.g. an item, a service, a person or a transaction entity like a session
- ResponseDateTime [0..1] This is the datetime at which a response was made for a request
- 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.
- 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.
- 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
- 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
- Description [0..*]
- Note [0..*]
- OriginatorParty [0..1] Identifies the party that originated the purchase of the goods, service or payment.
- RecipientParty [0..1] Identifies the recipient of the goods or services.
- CatalogParty [0..*] Identifies the party whose catalog is used to purchase the goods or services.
- 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.
- Extension [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 Extension is always the last element in all components, except where the component has been extended inline.
from type IdentificationTypefrom type OnlineSessionBaseTypefrom group FreeFormTextGroup
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| typeCode | [0..1] | CodeType_1E7368 | from type IdentificationType | |
| actionCode | [0..1] | ActionCodeContentType | from type IdentificationType |
Used in
- Type AcknowledgeOnlineSessionDataAreaType (Element DataArea)
- Type CancelAcknowledgeOnlineSessionDataAreaType (Element DataArea)
- Type CancelOnlineSessionDataAreaType (Element DataArea)
- Type ChangeAcknowledgeOnlineSessionDataAreaType (Element DataArea)
- Type ChangeOnlineSessionDataAreaType (Element DataArea)
- Type GetOnlineSessionDataAreaType (Element DataArea)
- Type NotifyOnlineSessionDataAreaType (Element DataArea)
- Type ProcessOnlineSessionDataAreaType (Element DataArea)
- Type ShowOnlineSessionDataAreaType (Element DataArea)
- Type SyncOnlineSessionDataAreaType (Element DataArea)
- Type SyncResponseOnlineSessionDataAreaType (Element DataArea)
Sample instance
<OnlineSession> <ID/> <IDSet> <ID/> </IDSet> <SessionID>normalizedString</SessionID> <User> <ID/> <IDSet> <ID/> </IDSet> <GroupID>normalizedString</GroupID> <UserAccount> <ID/> <IDSet>... </IDSet> <SystemID>normalizedString</SystemID> <AccountID>normalizedString</AccountID> <AccountTypeCode>normalizedString</AccountTypeCode> <UserAuthorization>... </UserAuthorization> <Extension>....................................... </Extension> </UserAccount> <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> </User> <RequestDateTime></RequestDateTime> <ResponseDateTime></ResponseDateTime> <ReplyURL>normalizedString</ReplyURL> <RedirectURL>normalizedString</RedirectURL> <ReturnURL>normalizedString</ReturnURL> <RequestLanguageCode>token</RequestLanguageCode> <Description/> <Note/> <OriginatorParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <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> </OriginatorParty> <RecipientParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <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> </RecipientParty> <CatalogParty> <ID/> <PartyIDSet> <ID/> </PartyIDSet> <TaxIDSet> <ID/> </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location> <ID/> <IDSet>... </IDSet> <Name/> <Directions/> <Coordinate>... </Coordinate> <Address>... </Address> <Contact>... </Contact> <Communication>... </Communication> <PostalAddress>... </PostalAddress> <PhysicalAddress>... </PhysicalAddress> <Description/> <Note/> <TimeZoneCode>M0100</TimeZoneCode> <AvailableTimePeriod>.................. </AvailableTimePeriod> <LocationEquipmentSpecification>... </LocationEquipmentSpecification> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Location> <Contact> <ID/> <IDSet>... </IDSet> <PersonName>... </PersonName> <RoleCode>normalizedString</RoleCode> <JobTitle/> <Responsibility/> <OrganizationUnitID>normalizedString</OrganizationUnitID> <Communication>... </Communication> <TelephoneCommunication>... </TelephoneCommunication> <EMailAddressCommunication>... </EMailAddressCommunication> <InternetAddressCommunication>... </InternetAddressCommunication> <Preference>... </Preference> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <Extension>....................................... </Extension> </Contact> <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> </CatalogParty> <SearchTerm> <ID/> <IDSet> <ID/> </IDSet> <SearchValueText/> <InclusiveIndicator>true</InclusiveIndicator> <ExactMatchIndicator>true</ExactMatchIndicator> <Operator/> <SearchQualifier/> <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> </SearchTerm> <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> </OnlineSession>