WBCL gate, WRITE_REQUEST function

The WRITE_REQUEST function appends the request body to the HTTP request being composed, and schedules it to be sent. It also handles sending a chunk of data.

Input Parameters

METHOD
Values for the parameter are:
  • DELETE
  • GET
  • HEADS
  • LINK
  • OPTIONS
  • POST
  • PUT
  • REQUEUE
  • TRACE
  • UNLINK
SESSION_TOKEN
ACTION
Optional Parameter
Values for the parameter are:
  • EVENTUAL
  • EXPECT
  • IMMEDIATE
ACTION_PARAMETER
Optional Parameter
BODY
Optional Parameter
A buffer that contains the HTTP request.
CHARSET
Optional Parameter
CHUNK
Optional Parameter
A block that contains chunked data.
CLOSE
Optional Parameter
Values for the parameter are:
  • NO
  • YES
CONTAINER_NAME
Optional Parameter
The name of the container that contains the request.
CONTAINER_POOL
Optional Parameter
The container pool of which the named container is a member.
CONVERSE
Optional Parameter
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
HOST_CODEPAGE
Optional Parameter
MEDIATYPE
Optional Parameter
PATH
Optional Parameter
QUERY_STRING
Optional Parameter
TRANSLATE
Optional Parameter
Values for the parameter are:
  • NO
  • YES
URIMAP
Optional Parameter

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_MEDIATYPE
  • INVALID_PATH
  • INVALID_RESPONSE_HEADER
  • INVALID_SCHEME
  • INVALID_SESSION_TOKEN
  • INVALID_URL
  • 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.


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