ParcelInBoxArchiveEx()


InBox Archive List for a specified Network/Mailbox.

Public Function ParcelInBoxArchiveEx(ByVal SessionID As String, _
                                    
ByVal NetworkID As Integer, _
                                     ByVal MailboxID As Integer, _
                                     ByVal BeginDate As Date, _
                                     ByVal EndDate As Date, _
                                     ByVal ECGridIDFrom As Integer, _
                                     ByVal ECGridIDTo As Integer, _
                                     ByVal MailbagControlID As String, _
                                     ByVal PageNo As Short, _
                                     ByVal RecordsPerPage As Short
) _
                                     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().
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. Set value to zero (0) to match any Sender. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. Set value to zero (0) to match any Receiver. See ECGridIDs
MailbagControlID 
String(0,15)  
Optional value to match the X12.56 Mailbag Control ID for the Parcel. 
PageNo 
Short
Selects page of records to return for certain function, used in conjunction with RecordsPerPage. A value of -1 indicates to return all records. 
RecordsPerPage 
Short
Selects number of records to return for certain function, used in conjunction with PageNo. A value of -1 indicates to return all records. 

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 the Parcel. 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

This method returns a list of from a specified Network/Mailbox InBox Archive. The actual content and manifest are kept on-line for at least 90-days, after that this information can be retrieved from ECGrid NetOps.

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 maximum span between BeginDate and EndDate is 31 days.

To run reports on the Session Network/Mailbox use ParcelInBoxArchive().

Example

Visual Basic
[insert code sample]

EventID: 6013

See Also

Parcels
ParcelInBoxArchive()
Authorization Level
SOAP Exceptions


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.