Purpose
Perform an
HTTP PATCH request.
Synopsis
function httppatch(url:string|text, data:string, result:string):integer
function httppatch(url:string|text, data:string, result:string, xhdr:string|text):integer
Arguments
|
url
|
URL to process
|
|
data
|
Data file to be sent to the server
|
|
result
|
File to store the result of the request
|
|
xhdr
|
Additional headers to add to the request
|
Return value
HTTP status of the request (
e.g. 200 for success, see Section
Constants for a list of predefined status code constants; value 999 indicates that an I/O error occurred during the operation) or the request number (≥1000) if asynchronous mode is active
Further information
1. The function returns after the request has been processed when synchronous mode is active (see
http_async). Otherwise, using asynchronous mode, the function returns immediately after having sent the request and the model is notified about the completion of the operation by an event of class
EVENT_HTTPEND. In this mode the result file
result must be a physical file (although drivers
"tmp:" and
"null:" can still be used).
2. The parameter
xhdr is typically used when the data type has to be specified. For instance, when the data sent is URL-encoded it may be necessary to use
"Content-Type: application/x-www-form-urlencoded" as the value for
xhdr in order to indicate to the server how to decode and process this data.
3. When cookie management is enabled (see
http_cookies) an additional header
"Cookie:" is inserted into the request if the cookie store contains compatible cookies. This behaviour is disabled if this optional header is already specified via the parameter
xhdr.
4. An IO error will be raised in case of failure during a file operation.
Related topics
Module
© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the
property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not
convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except
solely for internal evaluation purposes to determine whether to purchase a license to the software
described in this documentation, or as otherwise set forth in a written software license agreement
between you and FICO (or a FICO affiliate). Use of this documentation and the software described in
it must conform strictly to the foregoing permitted uses, and no other use is permitted.
