|
|
Method DetailString getCompression() Returns the compression (gzip or deflate), if any, of the response. Returns: String Since: 02-08-2023 Payload getConnectionInfo() Returns DNS, domain, and certificate information about this request. See ServiceRequest.checkConnection(). Returns: Payload Since: 07-12-2013 String getCookie(String name) Returns cookie by name
Parameters:
Returns: String Since: 05-31-2009 File getFile(String xpath, String filename, String contentType) Locates text node by xpath expression and creates a File object for it. Content of node should be base64 encoded. File.isValid will indicate success of the operation
Parameters:
Returns: File Since: 02-01-2010 int getResponseCode() Returns response code Returns: int Since: 12-22-2009 String getResponseHeader(String name) Returns response header value
Parameters:
Returns: String Since: 12-22-2009 Data getResponseHeaders() Returns response headers Returns: Data Since: 12-22-2009 int getResponseLength() Returns the length of the response body in bytes. Returns: int Since: 01-20-2010 String getResponseMessage() Returns response message Returns: String Since: 12-22-2009 long getResponseTime() Returns the response time in milliseconds it took for this request. Returns: long Since: 06-16-2021 String getUrl() Returns the URL of this connection if available. Returns: String Since: 06-16-2021 boolean isError() Returns true if request was not submitted successfully, false otherwise Returns: boolean Since: 12-22-2009 boolean isSuccess() Returns true if request was submitted successfully, false otherwise Returns: boolean Since: 12-22-2009 Data readAllTextData(String xpath) Creates data object by evaluating xpath expression on response body from first matching element using all descendant elements' names as keys and text nodes as values. Fails if response body is not xml.
Parameters:
Returns: Data Since: 07-12-2011 Data readAttributeData(String xpath) Creates data object by evaluating xpath expression on response body using attributes of first matching element. Fails if response body is not xml
Parameters:
Returns: Data Since: 12-22-2009 DataList readAttributeDataList(String name, String xpath) Creates datalist object by evaluating xpath expression on response body using attributes of matching elements. Fails if response body is not xml
Parameters:
Returns: DataList Since: 12-22-2009 String readBody() Reads the body of the response. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key. Returns: String Since: 01-20-2010 String readJSON() Reads the body of the response and converts it to JSON if it is XML. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key. Returns: String Since: 11-08-2016 Data readJSONData(String varName) Creates data object from javascript object notation string. varName should specify property containing associative array with required data. Specify null or empty string to use entire notation. Fails if response body is not JSON
Parameters:
Returns: Data Since: 12-22-2009 This method has been deprecated since 05-17-2016. Use Controller.createJsonParser(response.readBody()) DataList readJSONDataList(String name, String varName) Creates datalist object from javascript object notation string. varName should specify property containing array with required datalist. Fails if response body is not JSON
Parameters:
Returns: DataList Since: 12-22-2009 This method has been deprecated since 05-17-2016. Use Controller.createJsonParser(response.readBody()) String readNodeText(String xpath) Returns text of the first node selected by xpath expression. If node is an attribute then attribute value returned. If node is an element then element's text contents returned. Fails if response body is not xml
Parameters:
Returns: String Since: 12-24-2009 Data readTextData(String xpath) Creates data object by evaluating xpath expression on response body from first matching element using children elements' names as keys and text nodes as values. Fails if response body is not xml.
Parameters:
Returns: Data Since: 12-22-2009 DataList readTextDataList(String name, String xpath) Creates datalist object by evaluating xpath expression on response body from matching elements using children elements' names as keys and text nodes as values. Fails if response body is not xml
Parameters:
Returns: DataList Since: 12-22-2009 removeNamespaces() Removes namespaces from the payload XML so the content can be queried with XPATH. Since: 07-18-2018 setEncoding(String encoding) Sets the encoding to be used for reading the payload
Parameters:
Since: 03-05-2021 File toBinaryFile(String fileName) Returns raw content of this response as binary file. Content type of file will be based on file name and must be one of upload types supported by platform.
Parameters:
Returns: File Since: 12-27-2010 This method has been deprecated since 06-25-2018. Use toFile() File toFile(String fileName) Returns the content of this response as a File.
Parameters:
Returns: File Since: 06-25-2018 File toFile(String fileName, boolean asPdf) Returns the content of this response as a File. If asPdf=true, the file will be returned as PDF, otherwise as xml or json depending on the file extension. If no extension, xml will be assumed.
Parameters:
Returns: File Since: 08-27-2010 This method has been deprecated since 06-25-2018. Use toFile().toPdf() XMLReader transform(Fragment fragment) Performs a transform using the XSLT in the fragment and returns a new ServicePayload.
Parameters:
Returns: XMLReader Since: 08-27-2010 This method has been deprecated since 07-18-2018. Use removeNamespaces() String urlDecode(String value) Performs URL-decoding of specified value
Parameters:
Returns: String Since: 12-22-2009 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: May 01, 2024 05:15 AM |