on_end_response Event
Fired every time an end response is received from the server.
Syntax
class OFTPClientEndResponseEventParams(object): @property def virtual_file_name() -> str: ... @property def virtual_file_date() -> str: ... @property def destination() -> str: ... @property def originator() -> str: ... @property def creator() -> str: ... @property def reason_code() -> int: ... @property def reason_text() -> str: ... @property def file_hash() -> str: ... @file_hash.setter def file_hash(value) -> None: ... @property def signature() -> str: ... @property def direction() -> int: ... # In class OFTPClient: @property def on_end_response() -> Callable[[OFTPClientEndResponseEventParams], None]: ... @on_end_response.setter def on_end_response(event_hook: Callable[[OFTPClientEndResponseEventParams], None]) -> None: ...
Remarks
This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.
An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.
VirtualFileName specifies the name of the file.
VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".
Destination is the SFID of the destination system (this class).
Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.
Creator is the SFID of the remote system.
Direction specifies whether the end response is being received or sent. Possible values are:
0 | Received |
1 | Sent |
FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the on_end_transfer event when initially sending the file.
Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the send_end_response method.
ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |