WEB CONVERSE

Syntax

ibmCics.webConverse(new WebConverseOptions()
  .requestType(<RequestType>)
  [.uriMap(<UriMap>)]
  [.mediaType(<MediaType>)]
  .sessToken(<SessToken>)
  [.statusCode(<StatusCode>)]
  [.statusText(<StatusText>)]
  [.statusLen(<StatusLen>)]
  [.queryString(<QueryString>)]
  [.queryStrLen(<QueryStrLen>)]
  [.basicAuth(true)] 
  [.userName(<UserName>)]
  [.userNameLen(<UserNameLen>)]
  [.password(<Password>)]
  [.passwordLen(<PasswordLen>)]
  [.channel(<Channel>)]
  [.container(<Container>)]
  [.toChannel(<ToChannel>)]
  [.toContainer(<ToContainer>)]
  [.from(<From>)]
  [.fromLength(<FromLength>)]
  [.into(<Into>)]
  [.setPointer(<SetPointer>)]
  [.close(true)]  
  [.noHandle(true)]
);

Parameters

<RequestType>

The HTTP method to perform, for example GET, POST or PUT.

<UriMap>

Name of the URIMAP to be used. See URIMAP Config.

<MediaType>

The media type of the message body, for example 'text/xml'.

<SessToken>

The session token of the connection.

<StatusCode>

Data area to receive the HTTP status code, for example 200, 404 or 500.

<StatusText>

Data area to receive the text of the HTTP status, for example 'OK', 'Not Found' or 'Internal Server Error'.

<StatusLen>

Maximum length of the 'StatusText' data area.

<QueryString>

Query string to be send to the server.

<QueryStrLen>

Length of the 'QueryString'.

<basicAuth>

Optional boolean. Set to true when the connection to the web server requires HTTP Basic Authentication.

<UserName>

Username to be used.

<UserNameLen>

Length of the 'UserName'.

<Password>

Password to be used.

<PasswordLen>

Length of the 'Password'.

<Channel>

Name of the channel owning the container holding the HTTP body.

<Container>

Name of the container holding the HTTP body to be send to the server.

<ToChannel>

name of the channel owning the container which will be receiving the data from the server.

<ToContainer>

Name of the container receiving the data from the server.

<From>

Data area containing the message body.

<FromLength>

Length of the message body.

<Into>

Data area to receive the data from the server.

<SetPointer>

Optional variable. If set, the value will be updated to the address of the received date.

<close>

Optional boolean. If set to true, connection to the web server will be closed after the request.

<noHandle>

Optional boolean. If set to true, exceptions created by this command will be ignored.

Examples

EXEC CICS
    WEB CONVERSE
        SESSTOKEN(WS-SESSTOKEN)
        POST
        MEDIATYPE(WS-MEDIATYPE)
        CONTAINER(WS-CONTAINER)
        CHANNEL(WS-CHANNEL)
        INTO(WS-DATA)
END-EXEC.

ibmCics.webConverse(new WebConverseOptions()
  .requestType("POST")
  .mediaType(locDef.ws_Mediatype)
  .sessToken(locDef.ws_Sesstoken)
  .channel(locDef.ws_Channel)
  .container(locDef.ws_Container.getStrValue())
  .into(locDef.ws_Data)
);