Class EbicsService

Namespace
Subsembly.EBICS
Assembly
Subsembly.EBICS.Core.dll

Represents an EBICS Service or ServiceFilter element.

public sealed class EbicsService : EbicsElement
Inheritance
EbicsService
Inherited Members

Constructors

EbicsService(EbicsServiceMapRecord, string) 

public EbicsService(EbicsServiceMapRecord aMapRecord, string sTagName = "Service")

Parameters

aMapRecord EbicsServiceMapRecord
sTagName string

EbicsService(string) 

public EbicsService(string sTagName = "Service")

Parameters

sTagName string

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".

public string ContainerType { get; set; }

Property Value

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).

public string MsgFormat { get; set; }

Property Value

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".

public string MsgIdentifier { get; }

Property Value

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.

public string MsgName { get; set; }

Property Value

string

Remarks

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

MsgVariant

Optional message variant.

public string MsgVariant { get; set; }

Property Value

string

MsgVersion

Optional ISO version of message.

public string MsgVersion { get; set; }

Property Value

string

Scope

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

public string Scope { get; set; }

Property Value

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.

public string ServiceName { get; set; }

Property Value

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

public string ServiceOption { get; set; }

Property Value

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 

public string TagName { get; }

Property Value

string

Methods

BuildXml(XmlDocument, EbicsVersion) 

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

ParseXml(XmlElement, EbicsVersion) 

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement
nVersion EbicsVersion

ToString() 

public override string ToString()

Returns

string