Header

Every message header has a sign-on element that authenticates the message, and it may have a sign-off element that ends a particular session.

The header has four elements:

• SignonRq

• SignonRs

• SignoffRq

• SignoffRs

The header for a request has the header element <SignonRq>. The header for the response has the header element <SignonRs>. Similarly, the sign-off elements are specifically for requests and responses.

Note: IFX XML messages must be either requests or responses. Requests and responses cannot be mixed in a single message. A request uses <SignonRq>. A response uses <SignonRs>.

Signon Information

The <SignonRq> or <SignonRs> header element provides a location for status information, authentication information, date and time stamps, language preferences, and identification of the application that will use the data. You can find complete information in the IFX specification.

Authentication Information

The initial <SignonRq> for any session must provide authentication information, typically the user name and password, or a certificate ID. When the server authenticates the user, using the information in the header, the server issues a session key in the <SignonRs>. Subsequent messages use the session key as a token. After a session has finished, any subsequent session must start with the authentication information again.

Following is an example of an initial SignonRs authentication element.

	<SignonRq>
		<SignonPswd>
			<CustId>
				<SPName>com.siebel</SPName>
				<CustLoginId>RLIU</CustLoginId>
			</CustId>
			<CustPswd>
				<CryptType>NONE</CryptType>
				<Pswd>DROWSSAP</Pswd>
			</CustPswd>
			<GenSessKey>1</GenSessKey>
		</SignonPswd>
		<ClientDt>2001-11-16T16:56:39.0-08:00</ClientDt>
		<CustLangPref>ENU</CustLangPref>
		<ClientApp>
			<Org>Siebel FINS</Org>
			<Name>Siebel FINS Application</Name>
			<Version>7.0</Version>
		</ClientApp>
	</SignonRq>

Additional elements may be included in a Signon element. You can find complete information in the IFX specification.

Status information, which includes error codes, may also appear in the Signon element. Status information is discussed in IFX XML Status Information and Error Codes.

Signoff Information

The Signoff header element is used to end a session. A typical time to end a session is at the close of business for the day.

The Signoff element, <SignoffRq> or <SignoffRs>, appears at the end of the message, just before the end of the envelope </IFX>. The Signoff element may optionally contain a <custID> element.