Contains the public classes, interfaces, and enumerations that make up the BargeEx API. These classes are used to create CICA documents and send or retrieve them using BargeEx.
Classes
| Class | Description | |
|---|---|---|
 | Address |
Provides details about an address used in a document.
|
| Barge |
Represents a barge.
|
| BargeExService |
Provides a connection to and method allowing interaction with a BargeEx
environment.
|
| BargeInvoice |
Represents the CICA document called Barge Invoice
Document.
|
| BargeServiceOrder |
Represents the CICA document called Barge Service Order
Document.
|
| BargeServiceOrderResponse |
Represents the CICA document called Barge Service Order
Response Document.
|
| BargeStatus |
Represents the CICA document called Barge Status
Document.
|
| Boat |
Represents a boat.
|
| BoatStatus |
Represents the CICA document called Boat Status Document.
|
| DataMapPair |
Represents a BargeEx Master Data Mapping.
|
| DocumentAcknowledgment |
Represents the CICA document called Document Acknowledgment
Document (D_31).
|
| DocumentError |
Provides details about a syntax error.
|
| DocumentHeader |
Provides control information for a document which uniquely identifies
the document.
|
| FileAttachment |
Represents an attachment to a document.
|
| Incidental |
Provides details about an incidental (e.g. additional fee).
|
| InvoiceLineItem |
Represents an invoice line item.
|
| OrderLineItem |
Represents an order line item.
|
| OrderResponseLineItem |
Represents an order line item.
|
| Organization |
Provides information about an organization used in a document.
|
| RateInformation |
Represents the billing rate information for a product or service.
|
| TelephoneInformation |
Provides details about a telephone number used in a document.
|
| TowStatus |
Represents the CICA document called Tow Status
Document.
|
| UnsupportedDocumentException |
The exception that is thrown when an unsupported document is encountered.
|
| Utilities |
Provides various useful methods related to BargeEx or CICA Document
generation.
|
Interfaces
| Interface | Description | |
|---|---|---|
 | IDocument |
Represents a CICA document that can be sent to or received from another
trading partner using BargeEx.
|
| IReceiverAdaptor |
Defines the interface a BargeEx Receiver Adaptor class must implement
so that it can used by the BargeEx Receiver windows service.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | CicaBargeCoverConfiguration |
Configuration of the covers on a barge.
|
| CicaBargeCoverType |
Type of covers on a barge.
|
| CicaBargeCurrentLoadStatus |
Specifies the current load status of a barge.
|
| CicaBargeEventStatusType |
Specifies the barge event, status, or line item type.
|
| CicaBargeHullType |
Specifies a barge's hull type.
|
| CicaBargeLoadStatus |
Specifies the load status of a barge.
|
| CicaBargeMaintenanceCodes |
Specifies a maintenance code used to indicate maintenance details
about the barge that need to be communicated to the receiver.
|
| CicaBargeRakeDirection |
Specifies a barge's rake direction with respect to the boat.
|
| CicaBargeSizeCategory |
Specifies a barge's size category.
|
| CicaBargeType |
Specifies a type of barge.
|
| CicaBoatEventStatusType |
Specifies the boat event or status type.
|
| CicaCleanType |
Specifies a cleaning operation.
|
| CicaCommodityQuantityUnitCode |
Specifies the unit of measure or unit type for a commodity quantity.
|
| CicaCoverHandlingType |
Specifies a cover handling operation.
|
| CicaDelayType |
Specifies a type of barge delay.
|
| CicaDocumentErrorCode |
Specifies the reason a CICA document was not accepted.
|
| CicaDocumentResponseCode |
Specifies the overall result of a syntax analysis of the acknowledged
document.
|
| CicaDocumentType |
Specifies the type of a CICA document.
|
| CicaEventCompletionStatus |
Code indicating if an event was started, partially completed, or completed.
|
| CicaImageFileType |
Image attachment file extension types.
|
| CicaIncidentalCode |
Specifies an incidental type.
|
| CicaOffsetUnitCode |
Specifies the unit type for a document offset value.
|
| CicaOrderPurposeCode |
Specifies if the order is a new order, an update to an existing order,
or if the indicated order should be disregarded.
|
| CicaOrderResponseCode |
Specifies if an order or an order line item was accepted, rejected, or
partially accepted.
|
| CicaOrderType |
Specifies an order type.
|
| CicaPumpType |
Specifies a pump type.
|
| CicaRateType |
Specifies the type of rate that is used to calculate a cost (e.g.
estimated cost, incidental cost, line item cost, etc.).
|
| CicaRepairType |
Specifies a type of repair.
|
| CicaShiftType |
Specifies if a shift has been scheduled, started, or completed.
|
| CicaTelephoneDevice |
Specifies a telephone’s device type.
|
| CicaTelephoneLocation |
Specifies if a telephone is a home phone or a work phone.
|
| CicaTelephoneService |
Specifies the type of service this telephone provides
(i.e. Answering Service, Operator Standing By, Voice Mail).
|
| CicaTransactionPurposeCode |
Specifies if a document is a new transaction, a document is an update to a
previously sent transaction, or if the transaction represented by a
previously sent document should be disregarded.
|
| CicaUnitRateQuantityUnitCode |
Specifies the unit of measure or unit type for a unit rate quantity.
|
| CicaWaterwayDirection |
Specifies the direction of a waterborne vessel.
|
| DataMapType |
Specifies the different types of data on which BargeEx can perform data
mapping operations.
|
| GetNextDocumentReturnCode |
Specifies the result code returned by the
BargeExService.GetNextDocument
method.
|
| SendDocumentReturnCode |
Specifies the result code returned by the
BargeExService.SendDocument
method.
|
| StandardReturnCode |
Specifies the result code returned by the
BargeExService.Test,
BargeExService.GetNextDocument,
and
BargeExService.AcknowledgeDocument
methods.
|
| UpdateDataMappingReturnCode |
Specifies the result code returned by the
BargeExService.UpdateDataMapping
method.
|
