Transaction Webservice API

WebServiceRequest

Method Summary
String getClientAddress()

Returns the IP Address of the client.

Data getData()

Returns the Data object for this request. This will contain all the form field values posted from the client.

File getDocument(String name)

Returns the document File object identified by name. Note, web service clients must set the filename of the document to name.

File getDocumentByIndex(int index)

Returns the document with the given index. This is 0 based so index=0 is the first document.

int getDocumentCount()

The number of documents sent.

XMLReader getPayload()

Returns optional payload sent in web service request. This method returns null if there is no payload in the request

String toString()

Returns a description of this object.

Method Detail


String getClientAddress()

Returns the IP Address of the client.

Returns:  String

Since: 01-11-2012

top

Data getData()

Returns the Data object for this request. This will contain all the form field values posted from the client.

Returns:  Data

Since: 05-31-2007

top

File getDocument(String name)

Returns the document File object identified by name. Note, web service clients must set the filename of the document to name.

Parameters:

  • String   name

Returns:  File

Since: 05-31-2007

top

File getDocumentByIndex(int index)

Returns the document with the given index. This is 0 based so index=0 is the first document.

Parameters:

  • int   index

Returns:  File

Since: 10-03-2008

top

int getDocumentCount()

The number of documents sent.

Returns:  int

Since: 10-03-2008

top

XMLReader getPayload()

Returns optional payload sent in web service request. This method returns null if there is no payload in the request

Returns:  XMLReader

Since: 05-25-2010

top

String toString()

Returns a description of this object.

Returns:  String

Since: 06-14-2007

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM