GetVoucherInformation (Opus Funktion)

Inhaltsverzeichnis

• Beschreibung
• Argumente
• Rückgabewert Object VoucherInformation
• Beispiel
• Siehe auch

Beschreibung

Validates a voucher code for a given product and returns full voucher details. IsValid indicates whether the code is currently valid and applicable.

Argumente

Name	Typ	Beschreibung
VoucherCode	string	Gutschein-Code
CompanyID	integer	ID der Unternehmung (SSE_Company)
ProductDefinitionID	integer	ID der Preisdefinition, für welche der Gutschein eingelöst werden soll (SSF_ProductDefinitionID)
Valuta	datetime	(optional) Datum für welches die Gültigkeit geprüft werden soll. Es wird nur das Datum berücksichtigt, die Zeit ist nicht relevant. Defaultwert ist null
PersonID	integer	(optional) ID der Person (SSP_Person), für welche der Gutschein geprüft werden soll Defaultwert ist 0
LanguageID	integer	(optional) ID der Sprache, in welcher die Texte geliefert werden sollen Defaultwert is 0

Rückgabewert Object VoucherInformation

Gibt ein VoucherInformation zurück.

Name	Typ	Beschreibung
VoucherID	integer	SSF_VoucherID des zugeordneten Gutscheins. Es kann nur entweder VoucherID oder PersonVoucherID einen Wert haben.
PersonVoucherID	integer	SSF_PersonVoucherID des zugeordneten Gutscheins. Es kann nur entweder VoucherID oder PersonVoucherID einen Wert haben.
VoucherTypeProductID	integer	Falls die relevante Zuordnung über das Produkt im Gutscheintyp war, dann steht hier die entsprechende ID drin. Es wird nur eine ID in der Gruppe ausgefüllt.
VoucherTypeProductDefinitionID	integer	Falls die relevante Zuordnung über die Preisdefinition im Gutscheintyp war, dann steht hier die entsprechende ID drin. Es wird nur eine ID in der Gruppe ausgefüllt.
VoucherProductID	integer	Falls die relevante Zuordnung über das Produkt im Gutschein war, dann steht hier die entsprechende ID drin. Es wird nur eine ID in der Gruppe ausgefüllt.
VoucherProductDefinitionID	integer	Falls die relevante Zuordnung über die Preisdefinition im Gutschein war, dann steht hier die entsprechende ID drin. Es wird nur eine ID in der Gruppe ausgefüllt.
PersonVoucherProductID	integer	Dieser Wert ist immer 0. Er ist für spätere Zwecke reserviert.
VoucherCode	string	Gutschein-Code
VoucherInformationText	string	Informationstext zum Gutschein
VoucherTypeAdditionalProductDefinitionIDList	[integer]	Liste von Preisdefinitionen vom Gutscheintyp, welche hinzugefügt werden sollen, wenn mit diesem Gutschein fakturiert wird. Höchstens eine der zwei Listen hat Elemente.
VoucherAdditionalProductDefinitionIDList	[integer]	Liste von Preisdefinitionen vom Gutschein, welche hinzugefügt werden sollen, wenn mit diesem Gutschein fakturiert wird. Höchstens eine der zwei Listen hat Elemente.
ProductDefinitionModifierID	integer	ID vom SSF_ProductDefinitionModifier, welches zur angefragten Preisdefinition gehört. Dort sind normalerweise die Informationen über neuen Preis oder Rabatt etc. gespeichert. Siehe SSF_ProductDefinitionModifierObject. Falls es keinen entsprechenden Datensatz gibt, ist dieser Wert = 0.
IsValid	integer	0 = Der Gutschein-Code ist für die gemachten Angaben nicht gültig 1 = Der Gutschein-Code ist gültig

Beispiel

Lo_VoucherInformation = GetVoucherInformation("Voucherxyz", Li_CompanyID, Li_ProductDefinitionID); if (Lo_VoucherInformation.IsValid) { Result = "OK"; }

Siehe auch

---