Example Requests for the HTTP Protocol in Session Mode

HTTP protocol requests can be represented as URLs for HTTP GET, and as a combination of URL and request body for HTTP POST. The following topics explain in detail how each of the session mode calls is configured.

The following table describes each of the Login HTTP Request variables for session mode.

Variable	Description
webserver	URL of the Web server that has Siebel Application Interface (AI) installed, such as www.myserver.com.
path	Virtual path on the server referring to the specific AI profile configuration. The default is `/siebel/app/eai/lang`, where lang is the language in which you are running the applicable Siebel Application Object Manager.
source	Named subsystem as specified in the `[HTTP Services]` section in the application configuration (.cfg) file.
username	Siebel user name for the Application Object Manager login. Note: Passing user credentials in the URL is not supported in Siebel CRM.
password	Password for the login user name.

Login HTTP Request Example

In this example, if the call completes successfully, then it returns a session cookie:

Using HTTP POST:

URL = http://webserver/path
HTTP Body = 
SWEExtSource=source&SWEExtCmd=ExecuteLogin&UserName=username&Password=<password>

Example Login URL:

http://www.example.com/siebel/app/eai/enu

Note: Passing user credentials in the URL is not supported in Siebel CRM.

Data Exchange HTTP Request Example

In this example, for the call to complete successfully, it must include the session cookie from the login:

Using HTTP GET:
```
URL = http://webserver/path?SWEExtData=data text
```
where data text is the business service input data. Most of the time, this is the text of an XML document that on the server side is converted to a property set and passed to the business service.
With GET requests, the XML document is included in the URL. Therefore the XML document must be URL-encoded. For example, the URL encoding for a space is %20.
To make sure that the decoded XML document passed to the XML Converter is valid, use an escape code for any special characters (that is, use an ampersand, followed by the special character’s escape characters, followed by a semi-colon) before encoding them for the URL. For more information, see the topic on special (escape) characters in XML Reference: Siebel Enterprise Application Integration.
Using HTTP POST:
```
URL = http://webserver/path
HTTP Body = data text
```
where data text is the business service input data. Most of the time, this is the text of an XML document that on the server side is converted to a PropertySet and passed to the business service.
Data that is sent as part of the URL must be in Unicode format before it is encoded for the URL. POST requests can send the data without URL encoding but must include the Content-Type HTTP header. The Content-Type must specify the character set of the incoming data, for example:
```
Content-Type=text/xml;charset="UTF-8"
```
Note: For XML messages being received by way of the Inbound HTTP Transport, only a Unicode (UTF-8 or UTF-16) format (with accordant encoding XML-processing header attribute and encoded XML data) is allowed. No ISO or Windows code pages are accepted.

Example Request URL:

http://www.exampleserver.com/siebel/app/eai/enu?SWEExtData=<?xml version="1.0"
encoding="UTF-8"?>

<SiebelMessage MessageId="" MessageType="Integration Object"
IntObjectName="Sample Account">

<ListofSampleAccount>

  <Account>
    <Name>A. K. Parker Distribution</Name>
    <ListOfContact>
      <Contact>
        <FirstName>Stan</FirstName>
        <LastName>Graner</LastName>
      </Contact>
    </ListOfContact>
  </Account>

</ListofSampleAccount>

</SiebelMessage>

Logoff HTTP Request

This request must include the session cookie from the login request.

Using HTTP GET:
```
URL = http://webserver/path?SWEExtCmd=Logoff
```
Note: Always use HTTP GET for the Logoff HTTP Request.

Example Logoff URL:

http://www.example.com/siebel/app/eai/enu?SWEExtCmd=Logoff