Transmitter5GetResultFromDeclareSalary Method |
Namespace: SwissDecTXAssembly: SwissDecTX.Transmitter5 (in SwissDecTX.Transmitter5.dll) Version: 5.0.0.0 (5.0.0.0)
Syntaxpublic void GetResultFromDeclareSalary(
XmlDocument xmlDoc,
XmlDocument plausibility,
string domainString,
out XmlDocument result,
out XmlDocument messageSent,
out XmlDocument messageReceived,
out XmlDocument declareSalaryResult
)
Public Sub GetResultFromDeclareSalary (
xmlDoc As XmlDocument,
plausibility As XmlDocument,
domainString As String,
<OutAttribute> ByRef result As XmlDocument,
<OutAttribute> ByRef messageSent As XmlDocument,
<OutAttribute> ByRef messageReceived As XmlDocument,
<OutAttribute> ByRef declareSalaryResult As XmlDocument
)
public:
virtual void GetResultFromDeclareSalary(
XmlDocument^ xmlDoc,
XmlDocument^ plausibility,
String^ domainString,
[OutAttribute] XmlDocument^% result,
[OutAttribute] XmlDocument^% messageSent,
[OutAttribute] XmlDocument^% messageReceived,
[OutAttribute] XmlDocument^% declareSalaryResult
) sealed
function GetResultFromDeclareSalary(xmlDoc, plausibility, domainString, result, messageSent, messageReceived, declareSalaryResult);
Parameters
- xmlDoc XmlDocument
- The original salary declaration previously sent using DeclareSalary(XmlDocument, XmlDocument, XmlDocument, XmlDocument, String, DateTime). Only the <RequestContext> and <Job> or <JobMonthTotal> parts are required so you could pass a shortened version of the original data. The transmitter retrieves the request ID from the original declaration and automatically adds a suffix to it, to satisfy the requirement that states that a new request ID must be used with every call. If your application creates and passes an ad-hoc <RequestContext> block (instead of passing the entire original declaration) you can use an asterisk (*), the empty string "" or the string "reqId" and the function will create a new request identifier for you. Of course if the original declaration already used the auto-generation feature and still contains "*", "" or "reqId" then there is nothing special to do. If you set a request ID yourself in the block you created, the transmitter still appends a suffix to it.
- plausibility XmlDocument
- The plausibility data that was returned from the call to DeclareSalary(XmlDocument, XmlDocument, XmlDocument, XmlDocument, String, DateTime)
- domainString String
- The domain from which to retrieve data, one of AHV-AVS, UVG-LAA, UVGZ-LAAC, KTG-AMC, BVG-LPP, FAK-CAF, TaxAtSource or Statistic. When there are multiple possible entries for a domain, concatenate the desired institution ID without any blank, as in TaxAtSource#KantonBE
- result XmlDocument
- 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 XmlDocument
- The signed message, just before it was encrypted and sent. This message is different from the one that was sent previously with DeclareSalary(XmlDocument, XmlDocument, XmlDocument, XmlDocument, String, DateTime). To be saved in the transmission journal.
- messageReceived XmlDocument
- The signed raw server reply just after decryption. To be saved in the transmission journal.
- declareSalaryResult XmlDocument
- The salary declaration result data, as returned by the server.
RemarksIf the <RequestID> tag contains a single asterisk character "*", the empty string "" or the string "reqId", this method will generate a unique identifier for you automatically (you need to parse the messageSent text to figure out the request ID that was created, or parse the server response). A valid SwissDecTX license is required to execute this method call.
ExampleCalling Transmitter.GetStatusFromDeclareSalary()
using SwissDecTX;
try {
var tx = new Transmitter5();
XmlDocument result, messageSent, messageReceived, declareSalaryResult;
tx.GetResultFromDeclareSalary(xmlDoc, plausibility, domainString, out result, out messageSent, out messageReceived, out declareSalaryResult);
} catch (Exception ex) {
MessageBox.Show(ex.Message, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
}
See Also