ParcelOutBoxErrorEx()

List of Parcels which could not be processed for a specified Network/Mailbox.


      Public Function ParcelOutBoxErrorEx(ByVal SessionID As 
      String, 
      _
                                    
      ByVal 
      NetworkID As Integer, _
                                    
      ByVal MailboxID As Integer, 
      _
                                    
      ByVal BeginDate As Date, 
      _
                                    ByVal EndDate As Date) 
      _
                                    
      As ParcelIDInfo()

Parameters

SessionID: String - GUID; The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
NetworkID: Integer; The ECGrid NetworkID assigned to the network.
MailboxID: Integer; The ECGrid MailboxID assigned to the ID on the specified network. A value of zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization Level.
BeginDate: Date; The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate: Date; The date & time to end a report. All dates are in UTC. See NowUTC().

Returns

ParcelIDInfo Collection

ParcelID

Long

The value assigned to track a specific Parcel on ECGrid.

ParcelBytes

Integer

The total number of bytes in the Parcel. This includes all interchanges and any X12.56 mailbag segments if present in the Parcel.

ParcelDate

Date

The date/time the Parcel was uploaded or created on ECGrid (UTC).

NetworkIDFrom

Integer

The NetworkID where the Parcel originated.

NetworkNameFrom

String(3,40)

The descriptive name of the Network.

MailboxIDFrom

Integer

The MailboxID where theParcel originated.

NetworkIDTo

Integer

The Parcel destination NetworkID.

NetworkNameTo

String(3,40)

The descriptive name of the Network.

MailboxIDTo

Integer

The Parcel destination MailboxID.

FileName

String(1,127)

The file name assigned to a Parcel. It will be stored on disk with this name.

MailbagControlID

String(0,9)

The X12.56 Mailbag Number if applied to this Parcel.

StatusDate

Date

The date/time this status was assigned (UTC).

StatusCode

String

The current status code associated with this Parcel. The 'M' prefix refers to the Parcel (Mailbag). The suffix is a Short.

StatusMessage

String

The description of the Status Code.

LocalStatus

Short

This is a status set by the developer to indicate local disposition of theParcel. The default is 0. Values 0-31 are reserved for ECGridOS designated common values.

Valid

Short - ECGridOSv0200.ParcelValid 
  ENUM

Indicating whether this Parcel was able to be processed completely.

Direction

Short - ECGridOSv0200.Direction 
  ENUM

Indicating whether this Parcel was posted to an InBox or OutBox.

Interchanges

Object Collection - InterchangeIDInfo

The list of Interchanges within the Parcel.

InterchangeID: Long; A value representing a specific Interchange within ECGrid.
InterchangeProcessDate: Date; The Date/Time an Interchange was processed into ECGrid.
NetworkIDFrom: Integer; The NetworkID where the Parcel originated.
NetworkIDTo: Integer; The Parcel destination NetworkID.
Standard: String; The standard used for the outside envelope: X12 (ISA) or EDIFACT (UNB).
Bytes: Integer; The total number of bytes in the Interchange. This includes the envelope, but will not include any X12.56 mailbag segments if present in the Parcel.
InterchangeControlID: String; For X12 and EDIFACT this will be the control number
InterchangeDateTime: Date; The Date/Time of an Interchange derived from the Interchange Envelope ISA or UNB segment.
StatusDate: Date; The date/time this status was assigned (UTC).
StatusCode: String; The current status code associated with this Interchange. The 'E' prefix refers to the Interchange (Envelope). The suffix is a Short.
StatusMessage: String; The description of the Status Code.
DocumentType: String; A listing of document type(s) in an interchange (e.g. 810, 850, INVOIC, ORDERS, etc.)
Header: String; The complete X12 ISA or EDIFACT UNB for the interchange.
TPFrom: Object - ECGridIDInfo; An ECGridIDInfo Object for the Interchange Sender.
TPTo: Object - ECGridIDInfo; An ECGridIDInfo Object for the Interchange Receiver.

Remarks

The method returns a list of Parcels that have a Valid value of other than ParcelValid.Valid (1) for a specified Network/Mailbox.

The current User must have the proper Authorization Level to query the specified Network/Mailbox or a SOAP Exception will be thrown.

The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At least one of the two when provided must be in the specified Network/Mailbox.

The Valid values are defined as follows:

ParcelValid.Invalid (0): There was something structurally wrong with the Parcel, and it could not be processed. The problems with the Parcel need to be corrected and resubmitted. ParcelNoteList() may be of assistance in finding the problem.
ParcelValid.ValidPartialRouted (2): The structure of the Parcel is valid; however, in a multi-Interchange Parcel (not recommended) some of the Interchanges had known Receiver Qualifier/IDs, some did not. The suspended Interchange(s) will be forwarded if a matching Trading Partner Qualifier/ID is added to ECGrid within 30 days.; TPTo = nothing, indicates that the Interchange could not be routed.
ParcelValid.ValidNoneRouted (3): The structure of the Parcel is valid; however, no Interchange(s) had known Receiver Qualifier/IDs. The suspended Interchange(s) will be forwarded if a matching Trading Partner Qualifier/ID is added to ECGrid within 30 days.; TPTo = nothing, indicates that the Interchange could not be routed.

The maximum span between BeginDate and EndDate is 31 days.

To create an OutBox error report for the Session Network/Mailbox use ParcelOutBoxError().

Example

Visual Basic

[insert code sample]

ParcelOutBoxErrorEx()

Parameters

Returns

ParcelIDInfo Collection

Remarks

Example

EventID: 6017

See Also