Class: VoltMxResponseObject

Class for interacting with Volt MX response.

`getDeviceHeaderParam(key As String) As String`
`getHeaderParam(key As String) As Variant`
`getStatusCode() As Integer`
`addDeviceHeaderParam(key As String, value As String)`
`addHeaderParam(key As String, value As Variant)`
`New(result As VoltMxResultObject, jsonObj As JsonObject)`

Public Function getDeviceHeaderParam(key As String) As String
Gets a device header parameter for the Foundry response.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the device header parameter

Code Sample
' The following code gets the Device-Memory header, if available Call VoltMxResponse.getDeviceHeaderParam("Device-Memory")

Public Function getHeaderParam(key As String) As Variant
Gets a header parameter from the Foundry response. This is only relevant for postprocessors.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the header parameter

Code Sample
'The following code aborts if response content-type was not JSON If (VoltMxResponse.getHeaderParam("Content-Type") != "application/json" Then Return

Public Function getStatusCode() As Integer
Gets the status code of the Foundry response. This is only relevant for postprocessors.

Code Sample
'The following code aborts immediately if main integration service request returned a status other than 200 If (VoltMxResponse.getStatusCode != 200) Then Return

Public Sub addDeviceHeaderParam(key As String, value As String)
Adds a device header parameter for the Foundry response. This proxies the corresponding method in VoltMxResult object.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key of the device header parameter
2	value	String		String value of the device header parameter

Code Sample
' The following adds a device header Call VoltMxResponse.addDeviceHeader("X-VOLTSCRIPT", "Ran")

Throws Exceptions
Message	Error Code	Comments
Adding response device header parameters is not relevant for PreProcessors	1001

Public Sub addHeaderParam(key As String, value As Variant)
Adds a header param to the Foundry response. This proxies the corresponding method in VoltMxResult object.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the Foundry response parameter
2	value	Variant		Value for the Foundry response parameter

Code Sample
' This code adds a header parameter to VoltMxRequest object Call VoltMxResponse.addHeaderParam("X-VOLTSCRIPT", "Ran")

Throws Exceptions
Message	Error Code	Comments
Adding header parameters is not relevant for PreProcessors	1001

Public Sub New(result As VoltMxResultObject, jsonObj As JsonObject)
Constructor
idx	Argument	Data Type	Attributes	Comments
1	result	VoltMxResultObject		Result object that will be passed back to Foundry
2	jsonObj	JsonObject		JsonObject containing the Foundry response object

Public Class VoltMxResponseObject