Class: VoltMxRequestObject

Class for interacting with Foundry request.

`getHeaderParam(key As String) As Variant`
`getIdentityParam() As String`
`getInputParam(key As String) As Variant`
`getRequestParam(key As String) As Variant`
`addInputParam(key As String, value As Variant)`
`addRequestParam(key As String, value As Variant)`
`New(result As VoltMxResultObject, serviceInputParams As JsonObject, identityParam As JsonObject, jsonObj As JsonObject)`

Public Function getHeaderParam(key As String) As Variant
Gets a header parameter from the Foundry request.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the header parameter

Code Sample
' This gets the user-agent header Dim userAgent as String userAgent = VoltMxRequest.getHeaderParam("user-agent")

Public Function getIdentityParam() As String
Gets a parameter from the JWT token for an identity service associated with this integration service, or an empty string if no identity service is assigned to this integration service.

Code Sample
'The following sample gets the base64-encoded JWT token passed from the identity service, which might be used to connect to a remote database Dim jwt as String jwt = VoltMxRequest.getIdentityParam()

Public Function getInputParam(key As String) As Variant
Gets an input parameter passed to Foundry.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the input parameter. Keys are case-sensitive

Code Sample
'The following sample gets username parameter and validates it's not blank Dim username as String username = VoltMxRequest.getInputParam("username") If (username = "") Then VoltMxResult.setErrorMessage("Username is required") Return False End If

Public Function getRequestParam(key As String) As Variant
Gets a Foundry request parameter. These are parameters like appID, used for internal Foundry processing. This is not for input parameters defined in the Foundry integration service mapping.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the request parameter. Keys are case-sensitive

Code Sample
'The following sample gets the ID of the app from which the integration service is running Dim appId as String appId = VoltMxRequest.getRequestParam("appID")

Public Sub addInputParam(key As String, value As Variant)
Adds an input parameter for the Foundry integration service. This proxies the corresponding function in VotMxResult object. Only relevant for preprocessors.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the input parameter
2	value	Variant		Value for the input parameter. This should be a scalar.

Code Sample
'The following code would add a username from a session parameter to the subsequent request, if available. This could be used to lazy-load the value. Dim username as String username = VoltMxSession.getAttribute("username") If (username != "") Then Call VoltMxRequest.addInputParam("username", username) Else ' E.g. extract from base64-decoded JWT token) End If

Throws Exceptions
Message	Error Code	Comments
Adding input parameters is only relevant for PreProcessors	1001

Public Sub addRequestParam(key As String, value As Variant)
Adds a request parameter to the Foundry request. This proxies the corresponding method in VoltMxResult. Only relevant for preprocessors.
idx	Argument	Data Type	Attributes	Comments
1	key	String		Key for the request parameter
2	value	Variant		Value for the request parameter

Code Sample
' This code adds a request parameter to the subsequent request Call VoltMxResult.addRequestParam("VOLT-MX-VOLTSCRIPT", "Code ran")

Throws Exceptions
Message	Error Code	Comments
Adding request parameters is only relevant for PreProcessors	1001

Public Sub New(result As VoltMxResultObject, serviceInputParams As JsonObject, identityParam As JsonObject, jsonObj As JsonObject)
Constructor. This is automatically called during extractObjects() and should not be run manually.
idx	Argument	Data Type	Attributes	Comments
1	result	VoltMxResultObject		Result object that will be passed back to Foundry
2	serviceInputParams	JsonObject		JsonObject of input parameters for the integration service
3	identityParam	JsonObject		JsonObject of identity parameter (or Nothing) for the integration service
4	jsonObj	JsonObject		JsonObject containing the Foundry request

Public Class VoltMxRequestObject