Transaction System API

SocketResponse

Provides functionality reading the response of a socket call.

Method Summary
Data getCookies()

Returns the cookies as they are after the call, like a browser would hold them: the ones sent with setCookie, plus the ones the web workflow set with request.setCookie, minus the ones it deleted. The name is the one the workflow used, and secure cookies are returned decrypted. Empty if the call failed. Pass this to setCookies on the next socket to continue.

int getResponseCode()

Returns response code

String getResponseHeader(String name)

Returns response header value

Data getResponseHeaders()

Returns response headers

String getResponseMessage()

Returns response message, if error.

Data getSessionValues()

Returns the session values as they are after the call: the ones given with setSessionValue plus the ones the web workflow set with request.setSessionValue, minus the ones it removed. A socket call has its own session for the one call and nothing is carried to the next call: pass these to setSessionValues on the next socket to continue. Empty if the call failed.

boolean isError()

Returns true if request was not submitted successfully, false otherwise

boolean isSuccess()

Returns true if request was submitted successfully, false otherwise

String readBody()

Reads the response body.

String toString()

Returns a description of this object.

Method Detail


Data getCookies()

Returns the cookies as they are after the call, like a browser would hold them: the ones sent with setCookie, plus the ones the web workflow set with request.setCookie, minus the ones it deleted. The name is the one the workflow used, and secure cookies are returned decrypted. Empty if the call failed. Pass this to setCookies on the next socket to continue.

Returns:  Data

Since: 11-10-2026

top

int getResponseCode()

Returns response code

Returns:  int

Since: 11-04-2023

top

String getResponseHeader(String name)

Returns response header value

Parameters:

  • String   name

Returns:  String

Since: 11-04-2023

top

Data getResponseHeaders()

Returns response headers

Returns:  Data

Since: 11-04-2023

top

String getResponseMessage()

Returns response message, if error.

Returns:  String

Since: 11-04-2023

top

Data getSessionValues()

Returns the session values as they are after the call: the ones given with setSessionValue plus the ones the web workflow set with request.setSessionValue, minus the ones it removed. A socket call has its own session for the one call and nothing is carried to the next call: pass these to setSessionValues on the next socket to continue. Empty if the call failed.

Returns:  Data

Since: 11-10-2026

top

boolean isError()

Returns true if request was not submitted successfully, false otherwise

Returns:  boolean

Since: 11-04-2023

top

boolean isSuccess()

Returns true if request was submitted successfully, false otherwise

Returns:  boolean

Since: 11-04-2023

top

String readBody()

Reads the response body.

Returns:  String

Since: 11-04-2023

top

String toString()

Returns a description of this object.

Returns:  String

Since: 11-04-2023

top
Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. API Date: Nov 10, 2026 09:54 AM