Class GetOrderByCriteriaRequest

Set of criteria to restrict the search for postal payments.

Inheritance
System.Object
GetOrderByCriteriaRequest
Namespace: WebServices.DataContracts.Common
Assembly: WebServices.dll
Syntax
[DataContract]
public class GetOrderByCriteriaRequest

Properties

CurrentState

Current state of the searched postal payments; optional; can be multiple

Declaration
[DataMember]
public List<ST_StateIndicatorCode> CurrentState { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ST_StateIndicatorCode>

EventCode

List of event codes reached by the postal payment during the period if specified (between EventUtcDateFrom and EventUtcDateTo); state of any past event of the postal payment; optional; can be multiple

Declaration
[DataMember]
public List<ST_StateIndicatorCode> EventCode { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ST_StateIndicatorCode>

EventUtcDateFrom

Date and time UTC to restrict the searched postal payments, which have an event occurring after this specified date (or at the exact time of the specified date); optional

Declaration
[DataMember]
public DateTime? EventUtcDateFrom { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

EventUtcDateTo

Date and time UTC to restrict the searched postal payments, which have an event occurring strictly before this specified date; optional

Declaration
[DataMember]
public DateTime? EventUtcDateTo { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

IssuingOrganization

Code for the designated operator in charge of recording sender’s postal payment emission of reimbursement; e.g. J1CXXA; optional

Declaration
[DataMember]
public string IssuingOrganization { get; set; }
Property Value
Type Description
System.String

PayingOrganization

Code for the designated operator in charge of recording payment of postal payment; e.g. J1CXXA; optional

Declaration
[DataMember]
public string PayingOrganization { get; set; }
Property Value
Type Description
System.String

ProductCode

Product of the postal payment; e.g. OR for cash to cash; optional

Declaration
[DataMember]
public ST_ProductCode? ProductCode { get; set; }
Property Value
Type Description
System.Nullable<ST_ProductCode>

ProductType

Product type of the postal payment; e.g. U for urgent; optional

Declaration
[DataMember]
public ST_ProductTypeCode? ProductType { get; set; }
Property Value
Type Description
System.Nullable<ST_ProductTypeCode>

ServiceAgreementCode

Code of the service agreement to which the searched postal payments belong; optional

Declaration
[DataMember]
public string ServiceAgreementCode { get; set; }
Property Value
Type Description
System.String

Type

Type of the postal payments to be retrieved. It could be either International or Domestic; required

Declaration
[DataMember]
public ST_OrderType Type { get; set; }
Property Value
Type Description
ST_OrderType

Extension Methods