WBAP gate, SEND_RESPONSE function

The SEND_RESPONSE function identifies a CICS Document which is to be used as the body of a HTTP response, and the HTTP reason code with which that response is to be returned.

Input Parameters

ACTION
Optional Parameter
Values for the parameter are:
  • EVENTUAL
  • IMMEDIATE
CHUNKING
Optional Parameter
Specifies whether the data is to be chunked.
Values for the parameter are:
  • YES
  • NO
  • END
CLIENT_CODEPAGE
Optional Parameter
ASCII Code page into which the data is to be converted before being passed back to the caller
CLOSESTATUS
Optional Parameter
Controls sending of the connect: close header. If the session is not to persist then send the header. The default action is to not to send the connect: close header unless the client has indicated that it wants to close the connection after the response has been received.
Values for the parameter are:
  • CLOSE
  • NOCLOSE
CONVERSION
Optional Parameter
A binary parameter indicating whether the data is to undergo code page conversion.
Values for the parameter are:
  • NO
  • YES
DOCUMENT_TOKEN
Optional Parameter
The 8 byte field into which CICS places the document token identifying the document which contains the body of the HTTP response.
FROM
Optional Parameter
The block containing the data to be sent.
MEDIATYPE
Optional Parameter
SERVER_CODEPAGE
Optional Parameter
EBCDIC Code page of the data to be passed back
STATUS_CODE
Optional Parameter
HTTP response code with which the HTTP response is returned
STATUS_TEXT
Optional Parameter
Text to accompany HTTP response code with which the HTTP response is returned.

Output Parameters

REASON
The values for the parameter are:
  • CHUNK_INCOMPLETE
  • CHUNKING_NOT_SUPPORTED
  • CHUNKLENGTH_INVAL_HTTP10
  • CHUNKLENGTH_INVAL_NONHTTP
  • CLOSESTATUS_INVAL_NONHTTP
  • CONNECTION_CLOSED
  • DOCUMENT_NOT_FOUND
  • HEADER_MISSED_THE_BUS
  • INVALID_CHUNKSIZE
  • INVALID_CODEPAGE_COMBIN
  • INVALID_MEDIATYPE
  • INVALID_SEND_SEQUENCE
  • MSG_BODY_NOT_ALLOWED
  • NON_WEB_TRANSACTION
  • PREVIOUS_SEND_FAILED
  • SOCKETS_ERROR
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_WBAPsend_response.html | Timestamp icon Last updated: Monday, 5 June 2017