Class EnvelopeTaskItem

Items that have to be or have been processed by the task execution. They can be present in a call or result envelopes. They are elements matching a specific data definition according to the task being performed.

Inheritance
System.Object
EnvelopeTaskItem
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: IFSWebServices.XmlInternationalServices
Assembly: WebServices.dll
Syntax
[Serializable]
public class EnvelopeTaskItem : INotifyPropertyChanged

Properties

BusinessPartnerCode

It is the business partner of the EDI message. It is used by the Receive task call envelope. It is a string with a length of 6 characters.

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

ClearingIndicator

It indicates whether the EDI message is using the clearing or not. If not specified the value is considered false. It is used by the Send task call envelope.

Declaration
public bool ClearingIndicator { get; set; }
Property Value
Type Description
System.Boolean

ClearingIndicatorSpecified

Identify if clearing indicator is present or not in in call envelope.

Declaration
public bool ClearingIndicatorSpecified { get; set; }
Property Value
Type Description
System.Boolean

EDIXmlVersion

It is the XML version of the EDI message. It is always and only used by the TrackInternationalOrder result envelope. It is a string with a maximum length of 2 characters.

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

File

It is the content of the file or the object that has to be or has been processed. It can be for example an EDI message, a configuration file, a certificate, or a serialized object. It can be present in a call or result envelopes. It is a string with a maximal length of 500000 characters. Reserved characters in the file content must be replaced with character entities. For example "<" should be replaced by "<"

Example of an envelope call with serialized international money order item file
<Envelope XMLVersion="01" Direction="Call">
<Task Code="PayInternationalOrder">
<Item>
<File><MoneyOrder XMLVersion=”01”>
<MOId>J20AAZAFRAORN2050000100269</MOId>
<Events>
<Event>
<PaymentInformation>
<PaidAmount>171946.49</PaidAmount>
<PaidCurrencyCd>EUR</PaidCurrencyCd>
<Beneficiary>
<TitleCd>MM</TitleCd>
<LastName>Dupond</LastName>
<MiddleName>Jean</MiddleName>
<FirstName>Michel</FirstName>
<FstIdentificationTypeCd>PS</FstIdentificationTypeCd>
<FstIdentificationNo>5697879854</FstIdentificationNo>
</Beneficiary>
</PaymentInformation>
</Event>
</Events>
</MoneyOrder></File>
</Item>
</Task>
</Envelope>

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

FileName

It is the name of the file that has to be or has been processed. It can be present in a call or result envelope. It is a string with a maximal length of 100 characters.

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

ForceIssuingIndicator

Add force indicator for issuing order.

Declaration
public bool ForceIssuingIndicator { get; set; }
Property Value
Type Description
System.Boolean

ForceIssuingIndicatorSpecified

Identify if force issuing indicator is present or not in in call envelope.

Declaration
public bool ForceIssuingIndicatorSpecified { get; set; }
Property Value
Type Description
System.Boolean

MoneyOrderIdentifier

It is the money order identifier of the item.

For some Web services, it can also be the Customer Transaction Number (CTN). It is used in call and result envelopes. It is a string with a maximum length of 35 characters. For example:

  • J20AAZAFRAORN2050000000009(IFS money order)
  • 11330998229 (External monex order)
Declaration
public string MoneyOrderIdentifier { get; set; }
Property Value
Type Description
System.String

ProductCode

It is the product code of the item that has to be or has been processed by the task execution. It can be present in call or result envelope.

Declaration
public ST_ProductCode ProductCode { get; set; }
Property Value
Type Description
ST_ProductCode

ProductCodeSpecified

Identify if product code is present or not in in call envelope.

Declaration
public bool ProductCodeSpecified { get; set; }
Property Value
Type Description
System.Boolean

ProductTypeCode

It is the product type code of the item that has to be processed by the task execution. It can be urgent (U) or normal (N). It can be present in call envelope.

Declaration
public ST_ProductTypeCode ProductTypeCode { get; set; }
Property Value
Type Description
ST_ProductTypeCode

ProductTypeCodeSpecified

Identify if product type code is present or not in in call envelope.

Declaration
public bool ProductTypeCodeSpecified { get; set; }
Property Value
Type Description
System.Boolean

Result

They are the item results elements. They are only and always used in result envelopes. If the item has been successfully processed, it is one success element. If errors were raised, it is the list of errors.

Declaration
public List<EnvelopeTaskItemResult> Result { get; set; }
Property Value
Type Description
System.Collections.Generic.List<EnvelopeTaskItemResult>

StoreName

It is the machine store name of a certificate. It is always and only used by the CertificatesInformation task result envelope. It is a string with a maximal length of 256 characters. For example IFS_PROD_CONTAINER

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

Methods

RaisePropertyChanged(String)

Declaration
protected void RaisePropertyChanged(string propertyName)
Parameters
Type Name Description
System.String propertyName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged