WBCL gate, READ_RESPONSE function
The READ_RESPONSE function waits for and then reads the HTTP response that is expected from the HTTP server.
Input Parameters
- SESSION_TOKEN
- An 8-byte binary value that uniquely identifies the connection between CICS as an HTTP client, and an HTTP server.
- BODY
- Optional Parameter
- A buffer that will receive the HTTP response.
- CONTAINER_NAME
- Optional Parameter
- The name of the container that will receive the message body.
- CONTAINER_POOL
- Optional Parameter
- The container pool of which the named container is a member.
- HOST_CODEPAGE
- Optional Parameter
- MAX_DATA_LENGTH
- Optional Parameter
- STATUS_TEXT
- Optional Parameter
- Text to accompany HTTP response code with which the HTTP response is returned.
- TIME_OUT_VALUE
- Optional Parameter
- TRANSLATE
- Optional Parameter
- Values for the parameter are:
- NO
- YES
- TRUNCATE
- Optional Parameter
- indicates whether or not data is to be truncated if the buffer is too small.
- Values for the parameter are:
- NO
- YES
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- EXIT_LINKAGE_ERROR
- FREEMAIN_FAILED
- GETMAIN_FAILED
- LOOP
- The following values are returned when RESPONSE is EXCEPTION:
- BODY_NOT_ALLOWED
- BODY_REQUIRED
- BODY_TRUNCATED
- BROWSE_ERROR
- CHUNKING_ERROR
- CHUNKING_NOT_SUPPORTED
- COMBINATION_UNSUPPORTED
- CONNECT_FAILED
- CONNECTION_CLOSE_SENT
- CONNECTION_CLOSED
- CONTAINER_NOT_FOUND
- END_HEADERS
- ESCAPE_ERROR
- EXPECT_REJECTED
- HEADER_NAME_LENGTH_ERROR
- HEADER_NOT_FOUND
- HEADER_VALUE_LENGTH_ERROR
- HTTP_ERROR
- INVALID_CHARSET
- INVALID_CHUNK
- INVALID_CLIENT_CERTIFICATE
- INVALID_DOCUMENT_TOKEN
- INVALID_HOST
- INVALID_HOST_CODEPAGE
- INVALID_PATH
- INVALID_RESPONSE_HEADER
- INVALID_SCHEME
- INVALID_SESSION_TOKEN
- INVALID_URL
- MEDIATYPE_INVALID
- MEDIATYPE_NOT_ALLOWED
- MEDIATYPE_REQUIRED
- METHOD_NOT_ALLOWED
- NO_RESPONSE_HEADERS
- NOT_AUTHORIZED
- PARTIAL_BODY
- PIPELINING_ERROR
- PROXY_ERROR
- SOCKET_ERROR
- STATUS_TEXT_TRUNCATED
- TIMED_OUT
- TRANSLATE_ERROR
- UNKNOWN_HOST
- UNKNOWN_PROXY
- URIMAP_DISABLED
- URIMAP_HOST_ERROR
- URIMAP_NOT_FOUND
- URIMAP_PATH_ERROR
- XWBOPEN_ERROR
- The following values are returned when RESPONSE is DISASTER or EXCEPTION:
- UNEXPECTED_SOCK_RESPONSE
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- OMITTED_PARAMETER
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- STATUS_CODE
- CHARSET
- Optional Parameter
- MEDIATYPE
- Optional Parameter
- SET_BUFFER
- Optional Parameter