• API Overview
  • EBICS API
  • FinTS API
  • XS2A API
  • SEPA API
Search Results for

    Class EbicsProtocolEntry

    Stores the details of a single customer protocol entry (PTK)

    Inheritance
    System.Object
    EbicsElement
    EbicsProtocolEntry
    Implements
    IEbicsJsonConverter
    Inherited Members
    EbicsElement.BuildXmlDocument(EbicsVersion)
    EbicsElement.Load(Stream, EbicsVersion)
    EbicsElement.Load(String, EbicsVersion)
    EbicsElement.Save(Stream, EbicsVersion)
    EbicsElement.Save(String, EbicsVersion)
    EbicsElement.FromBuffer(EbicsDataBuffer, EbicsVersion)
    EbicsElement.ToBuffer(EbicsVersion)
    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 class EbicsProtocolEntry : EbicsElement, IEbicsJsonConverter
    Remarks

    The following example illustrates how the various properties are set from a given protocol text. Let's assume the following protocol text:

    26.11.09 11:48:14     Datei zur Bank uebertragen                        
             Hostname   : CBKEBIX1                                          
             Auftrag    : Inlandszahlungsverkehr                    IZV DQOD
             Teilnehmer : L4190030 SELLEAND Andreas Selle                   
             Ergebnis   : Uebertragung in Ordnung [01]                      
                          Datenuebertragung verschluesselt [04]             
                          Datenuebertragung komprimiert [05]                

    The individual properties will be set with the following values.

    TimeStamp2009-11-26 11:48:14
    ActionTextDatei zur Bank uebertragen
    ActionCode-1 Protocol entry sample contains no action ID in square brackets such as e.g. [21].
    OrderTextInlandszahlungsverkehr
    OrderTypeIZV
    OrderIDDQOD
    ResultTextUebertragung in Ordnung
    ResultCode1
    TextThe complete protocol entry text as shown above.
    DisplayFileOnly set if a display file was included (not in the example above)

    Properties

    ActionCode

    The value of the action code found in square brackets.

    Declaration
    public int ActionCode { get; set; }
    Property Value
    Type Description
    System.Int32

    If no action code is included in the protocol entry text, then this is -1. Otherwise the action code can range from 0 to 99.

    Remarks

    This only exists for a PTK protocol entry.

    ActionText

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

    For a HAC protocol entry this is the value from the OrgnlPmtInfId element.

    DisplayFile

    Optional display file text.

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

    If a display file or additional information text was included in the protocol entry, then it is stored in this property.

    ExternalReasonCode

    The External Reason Code from a HAC protocol entry.

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

    This is null for a PTK protocol entry.

    OrderID

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

    OrderText

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

    This only exists for a PTK protocol entry.

    OrderType

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

    ResultCode

    The value of the result code found in square brackets.

    Declaration
    public int ResultCode { get; set; }
    Property Value
    Type Description
    System.Int32

    If no result code is included in the protocol entry text, then this is -1. Otherwise the result code can range from 0 to 99.

    Remarks

    This only exists for a PTK protocol entry.

    ResultText

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

    This only exists for a PTK protocol entry.

    Text

    The complete, raw text of this protocol entry.

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

    This only exists for a PTK protocol entry, for a HAC protocol entry this is null.

    TimeStamp

    Declaration
    public DateTime TimeStamp { get; set; }
    Property Value
    Type Description
    System.DateTime

    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
    EbicsElement.BuildXml(XmlDocument, EbicsVersion)

    Clear()

    Declaration
    public void Clear()

    CreateProtocolEntry(JsonObject)

    Declaration
    public static EbicsProtocolEntry CreateProtocolEntry(JsonObject jsonObject)
    Parameters
    Type Name Description
    JsonObject jsonObject
    Returns
    Type Description
    EbicsProtocolEntry

    FromJson(JsonObject)

    Initializes an EbicsProtocolEntry from its json representation. FromJson(JsonObject).

    Declaration
    public void FromJson(JsonObject jsonObject)
    Parameters
    Type Name Description
    JsonObject jsonObject

    ParseXml(XmlElement, EbicsVersion)

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

    ToJson(JsonObject)

    Converts an EbicsProtocolEntry to its json representation. ToJson(JsonObject).

    Declaration
    public JsonObject ToJson(JsonObject jsonObject)
    Parameters
    Type Name Description
    JsonObject jsonObject
    Returns
    Type Description
    JsonObject

    ToString()

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

    Implements

    IEbicsJsonConverter

    Extension Methods

    EbicsJsonConverterExtensions.ToJson(IEbicsJsonConverter)
    In This Article
    Back to top Copyright 2009-2025 Subsembly GmbH