Transmitter5File2StringDeclareSalary Method |
Submit salary declaration to the SwissDec secure web service over the internet
Namespace: SwissDecTXAssembly: SwissDecTX.Transmitter5 (in SwissDecTX.Transmitter5.dll) Version: 5.0.0.0 (5.0.0.0)
Syntaxpublic void File2StringDeclareSalary(
string sourceFilePathName,
out string result,
out string messageSent,
out string messageReceived,
out string jobKey,
out DateTime transmissionDateUtc
)
Public Sub File2StringDeclareSalary (
sourceFilePathName As String,
<OutAttribute> ByRef result As String,
<OutAttribute> ByRef messageSent As String,
<OutAttribute> ByRef messageReceived As String,
<OutAttribute> ByRef jobKey As String,
<OutAttribute> ByRef transmissionDateUtc As DateTime
)
public:
virtual void File2StringDeclareSalary(
String^ sourceFilePathName,
[OutAttribute] String^% result,
[OutAttribute] String^% messageSent,
[OutAttribute] String^% messageReceived,
[OutAttribute] String^% jobKey,
[OutAttribute] DateTime% transmissionDateUtc
) sealed
function File2StringDeclareSalary(sourceFilePathName, result, messageSent, messageReceived, jobKey, transmissionDateUtc);
Parameters
- sourceFilePathName String
- The salary declaration to send.
- result String
- The server's reply, contains the result of the operation or any error that might occur during the validation, transmission and processing of the salary declaration.
- messageSent String
- The signed message containing the declaration, just before it was encrypted and sent. To be saved in the transmission journal.
- messageReceived String
- The signed raw server reply just after decryption. To be saved in the transmission journal.
- jobKey String
- The job key assigned by the server and associated with this submission. To be used later with GetStatusFromDeclareSalary(XmlDocument, String, XmlDocument, XmlDocument, XmlDocument, XmlDocument, Boolean)
- transmissionDateUtc DateTime
- The actual UTC date/time at which the transmission occurred.
RemarksThe UC005 (Replacement) and UC006 (Test) cases have to be handled at the application level, i.e. you simply insert the appropriate tag(s) in the XML declaration as described in the specification. There is absolutely no difference at the transmission level and the server will interpret your submission according to those options, if present. A valid SwissDecTX license is required to execute this method call. There is a 1-hour timeout on this call, as the Swissdec distributor 'thinks' for a while before returning from this call.
See Also