Class EbicsService

Represents an EBICS Service or ServiceFilter element.

Inheritance
System.Object
EbicsElement
EbicsService
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public sealed class EbicsService : EbicsElement

Constructors

EbicsService(EbicsServiceMapRecord, String)

Declaration
public EbicsService(EbicsServiceMapRecord aMapRecord, string sTagName = "Service")
Parameters
Type Name Description
EbicsServiceMapRecord aMapRecord
System.String sTagName

EbicsService(String)

Declaration
public EbicsService(string sTagName = "Service")
Parameters
Type Name Description
System.String sTagName

Properties

ContainerType

Indicates what type of container is used. One of the internal values has to be used (internal code list): "XML", "ZIP", or "SVC".

Declaration
public string ContainerType { get; set; }
Property Value
Type Description
System.String

MsgFormat

Evaluated together with MsgName, admissible for each kind of message name, but only to be used if it is not the standard format for the used message standard(especially non-XML for ISO 20022).

Declaration
public string MsgFormat { get; set; }
Property Value
Type Description
System.String
Remarks

„XML“, „ASN1“, „JSON“, „PDF“, etc. restriction: optional; minLength value = "1" maxLength value = "4" pattern = [A-Z.0-9]

MsgIdentifier

Provides the complete ISO message identifier built from MsgName, MsgVariant, and MsgVersion, e.g. "camt.052.001.04".

Declaration
public string MsgIdentifier { get; }
Property Value
Type Description
System.String
Remarks

If MsgName is null, then this property is null, too. If the MsgName ist not according to the name pattern "xxxx.nnn" (e.g. "camt.052"), then this is property is null. If the MsgVariant is not null and does not consist of three digits, then this is property is null. If the MsgVersion is not null and does not consist of two digits,then this is property is null. In any other case a combined ISO message identifier is produced. A missing MsgVariant is replaced by "000". A missing MsgVersion is replaced by "00".

MsgName

Message names starting with a BA code(ISO) or MT(FIN) or string to be evaluated.

Declaration
public string MsgName { get; set; }
Property Value
Type Description
System.String
Remarks

“pain.001”, “mt103” Message names (issued by markets, specified in “scope”) are also allowed.

MsgVariant

Optional message variant.

Declaration
public string MsgVariant { get; set; }
Property Value
Type Description
System.String

MsgVersion

Optional ISO version of message.

Declaration
public string MsgVersion { get; set; }
Property Value
Type Description
System.String

Scope

Specifies whose rules have to be taken into account for the service.

Declaration
public string Scope { get; set; }
Property Value
Type Description
System.String
Remarks

This means which market / community defined the rules. External scope name list specified and maintained by EBICS. A missing scope element means globally accepted rules. Scope is subject to an external code list (maintained by EBICS). 2-char country codes 3-char codes for other scopes “BIL” means bilaterally agreed The meaning of a missing Scope element is global. Instead of a missing scope element it can also be provided as code “GLB”.

ServiceName

Name of the service.

Declaration
public string ServiceName { get; set; }
Property Value
Type Description
System.String
Remarks

ServiceName is subject to an external code list (maintained by EBICS). Example: “SCT” = SEPA credit transfer.

ServiceOption

Optional characteristic(s) of a service

Declaration
public string ServiceOption { get; set; }
Property Value
Type Description
System.String
Remarks

ServiceOption is subject to external code lists(global, market, bilateral) Example: “URG” = urgent

restriction: optional; minLength value="3" maxLength value = "10" pattern = [A-Z0-9]

TagName

Declaration
public string TagName { get; }
Property Value
Type Description
System.String

Methods

BuildXml(XmlDocument, EbicsVersion)

Declaration
public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement
Overrides

ParseXml(XmlElement, EbicsVersion)

Declaration
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()