Greg Kolinski edited this page Sep 20, 2017 · 1 revision

Back To Appendix Home


The following Enums are defined in ECGridOS to facilitate creating better documented code.

NOTE: Enum values are interpreted by Web Services, so you cannot rely or determine the underlying value except at runtime.


APICall

public enum APICall {
        GenerateAPIKey,
        Login,
        Logout,
        ChangePassword,
        WhoAmI,
        UserAdd,
        UserAddEx,
        UserInfo,
        UserUpdate,
        UserActivate,
        UserSuspend,
        UserTerminate,
        UserReset,
        UserList,
        UserListEx,
        UserPassword,
        SessionLog,
        SessionLogEx,
        SessionLogCurrent,
        KeySave,
        KeyGet,
        KeyList,
        KeyRemove,
        UserSetNetworkMailbox,
        UserSetAuthLevel,
        UserListLockedOut,
        UserListLockedOutEx,
        UserResetAll,
        SetLocalTime,
        TerminateAPIKey,
        GeneratePassword,
        UserSendSMS,
        UserGetAPIKey,
        NetworkInfo,
        NetworkList,
        NetworkStatusSummary,
        NetworkOutageList,
        NetworkStart,
        NetworkStop,
        NetworkRestart,
        NetworkAdd,
        NetworkOwnerContact,
        NetworkErrorsContact,
        NetworkInterconnectsContact,
        NetworkNoticesContact,
        NetworkBillingContact,
        NetworkReportsContact,
        NetworkSetContact,
        NetworkGetContact,
        NetworkSetWebsite,
        NetworkSetStatus,
        NetworkInfoWithLog,
        NetworkBackupAllConfigs,
        NetworkX12Delimiters,
        MailboxAdd,
        MailboxAddEx,
        MailboxActivate,
        MailboxSuspend,
        MailboxTerminate,
        MailboxInfo,
        MailboxName,
        MailboxErrorsContact,
        MailboxInterconnectsContact,
        MailboxNoticesContact,
        MailboxX12Delimiters,
        MailboxInBoxTimeout,
        MailboxList,
        MailboxListEx,
        MailboxOwnerContact,
        MailboxManaged,
        MailboxDescription,
        MailboxUse,
        MailboxSetContact,
        TPAdd,
        TPAddVAN,
        TPAddEx,
        TPMove,
        TPMoveEx,
        TPUpdateDescription,
        TPActivate,
        TPSuspend,
        TPTerminate,
        TPInfo,
        TPSearch,
        TPSearchEx,
        TPList,
        TPListEx,
        TPFind,
        TPFindEx,
        TPDataEMail,
        TPSetMailboxDefault,
        TPGetMailboxDefault,
        TPEMailX400Format,
        TPMoveMailbox,
        TPSetRoutingGroup,
        TPListExPaged,
        TPListByOwner,
        TPSetOwner,
        InterconnectAdd,
        InterconnectUpdate,
        InterconnectNote,
        InterconnectCancel,
        InterconnectInfo,
        InterconnectNoteList,
        InterconnectListByECGridID,
        InterconnectListByStatus,
        InterconnectListByStatusEx,
        InterconnectAssignNetOps,
        InterconnectCount,
        InterconnectCountEx,
        InterconnectInfoGUID,
        MigrationAdd,
        MigrationAddAuthorization,
        MigrationSendRequest,
        MigrationUpdate,
        MigrationStatus,
        MigrationInfo,
        MigrationList,
        MigrationListEx,
        MigrationECGridIDAdd,
        MigrationECGridIDRemove,
        MigrationECGridIDStatus,
        MigrationECGridIDNote,
        CarbonCopyAdd,
        CarbonCopyAddEx,
        CarbonCopyActivate,
        CarbonCopySuspend,
        CarbonCopyTerminate,
        CarbonCopyInfo,
        CarbonCopyList,
        CarbonCopyListEx,
        ParcelInBox,
        ParcelInBoxEx,
        ParcelDownload,
        ParcelDownloadInner,
        ParcelDownloadConfirm,
        ParcelUpload,
        ParcelUploadEx,
        ParcelInfo,
        ParcelMainfest,
        ParcelInterchangeManifest,
        ParcelNoteList,
        ParcelInBoxArchive,
        ParcelInBoxArchiveEx,
        ParcelOutBoxArchive,
        ParcelOutBoxArchiveEx,
        ParcelOutBoxError,
        ParcelOutBoxErrorEx,
        InterchangeInBox,
        InterchangeInBoxEx,
        InterchangeOutBox,
        InterchangeOutBoxEx,
        InterchangeHeaderInfo,
        ParcelDownloadReset,
        InterchangeOutBoxNoRoute,
        InterchangeOutBoxNoRouteEx,
        ParcelUploadGZip,
        InterchangeInfo,
        InterchangeResend,
        ParcelUploadGZipEx,
        ParcelUploadExA,
        ParcelSetMailbagControlID,
        ParcelUpdateStatus,
        ParcelUpdateLocalStatus,
        ParcelUploadDirected,
        ParcelUploadDirectedGZip,
        ParcelDownloadConfirmPendingAck,
        InterchangeHeaderInfoB,
        ParcelDownloadGZip,
        ParcelDownloadCancel,
        ParcelTest,
        InterchangeManifest,
        ParcelOutBoxInProcess,
        ParcelOutBoxInProcessEx,
        ParcelResend,
        InterchangeCancel,
        ParcelAcknowledgmentNote,
        InterchangeOutBoxPending,
        InterchangeOutBoxPendingEx,
        InterchangeInBoxPending,
        InterchangeInBoxPendingEx,
        InterchangeInBoxArchive,
        InterchangeInBoxArchiveEx,
        InterchangeOutBoxArchive,
        InterchangeOutBoxArchiveEx,
        ParcelInBoxArchiveDescEx,
        ParcelOutBoxArchiveDescEx,
        CallBackAdd,
        CallBackActivate,
        CallBackSuspend,
        CallBackTerminate,
        CallBackList,
        CallBackListEx,
        CallBackEventList,
        CallBackEventListEx,
        CallBackInvoke,
        CallBackTest,
        CallBackPendingList,
        CallBackPendingListEx,
        CallBackQueueInfo,
        CallBackEventInfo,
        CallBackAddEx,
        CallBackFailedList,
        CallBackFailedListEx,
        CallBackEventSetStatus,
        ReportMonthly,
        ReportMonthlyEx,
        ReportTrafficStats,
        ReportTrafficStatsEx,
        ReportInstantStats,
        ReportInstantStatsEx,
        AS2Add,
        AS2Update,
        AS2Activate,
        AS2Suspend,
        AS2Terminate,
        AS2CertAddPublic,
        AS2CertAddPrivate,
        AS2CertTerminate,
        AS2Find,
        AS2List,
        AS2ListEx,
        AS2Info,
        AS2CertCreatePrivate,
        AS2Pair,
        AS2DefaultMailbox,
        AS2SetPair,
        AS2SetStatus,
        AS2CertRenewPrivate,
        GISBAdd,
        GISBUpdate,
        GISBActivate,
        GISBSuspend,
        GISBTerminate,
        GISBKeyAdd,
        GISBKeyTerminate,
        GISBFind,
        GISBList,
        GISBListEx,
        GISBInfo,
        CertificateAddPublic,
        CertificateAddPrivate,
        CertificateCreatePrivate,
        CertificateSetUsageDates,
        CertificateTerminate,
        CommAdd,
        CommUpdate,
        CommSetStatus,
        CommFind,
        CommList,
        CommListEx,
        CommInfo,
        CommPair,
        CommSetPair,
        ContractInfo,
        ContractList,
        ContractListEx,
        ContractAdd,
        ContractActivate,
        ContractSuspend,
        ContractTerminate,
        ContractExpiring,
        ContractSet,
        ContractSetEx,
        PricelistInfo,
        PricelistAdd,
        PricelistLineAdd,
        PricelistLineDelete,
        InvoiceCreate,
        InvoiceInfo,
        InvoiceList,
        InvoiceSetStatus,
        InvoiceCalculateLineItem,
    }

AuthLevel

public enum AuthLevel {
        
        NoChange,
        Root,
        TechOps,
        NetOps,
        NetworkAdmin,
        NetworkUser,
        MailboxAdmin,
        MailboxUser,
        TPUser,
        General,
    }

CellCarrier

public enum CellCarrier {
        NoChange,
        Undefined,
        ATTCingular,
        Verizon,
        TMobile,
        SprintPCS,
        Nextel,
        Alltel,
        VirginMobile,
        ATTPreCingular,
        ATT,
        BoostMobile,
        USCellular,
        MetroPCS,
        Powertel,
    }

CertificateSecureHashAlgorithm

public enum CertificateSecureHashAlgorithm {
        sha1,
        sha2,
    }

CertificateType

public enum CertificateType {
        X509,
        PGP,
        SSH,
    }

CertificateUsage

public enum CertificateUsage {
        SSL,
        Encryption,
        Signature,
        EncryptionAndSignature,
    }

CertStoreTypes

public enum CertStoreTypes {
        cstUser,
        cstMachine,
        cstPFXFile,
        cstPFXBlob,
        cstJKSFile,
        cstJKSBlob,
        cstPEMKeyFile,
        cstPEMKeyBlob,
        cstPublicKeyFile,
        cstPublicKeyBlob,
        cstSSHPublicKeyBlob,
        cstP7BFile,
        cstP7BBlob,
        cstSSHPublicKeyFile,
        cstPPKFile,
        cstPPKBlob,
        cstXMLFile,
        cstXMLBlob,
    }

Direction

public enum Direction {
        NoDir,
        OutBox,
        InBox,
    }

EDIStandard

public enum EDIStandard {
        X12,
        EDIFACT,
        TRADACOMS,
        VDA,
        XML,
        TXT,
        PDF,
        Binary,
    }

EMailPayload

public enum EMailPayload {
        Body,
        Attachment,
    }

EMailSystem

public enum EMailSystem {
        smtp,
        x400,
    }

eMailTo

public enum eMailTo {
        NoEMail,
        Requestor,
        Network,
        RequestorAndNetwork,
        Other,
        RequestorAndOther,
        NetworkAndOther,
        EMailAll,
    }

HTTPAuthType

public enum HTTPAuthType {
        None,
        Basic,
        Digest,
    }

InvoiceInclude

 public enum InvoiceInclude {
        AllCurrentCharges,
        MonthlyItemsOnly,
        SpecialChargesOnly,
    }

InvoiceStatus

public enum InvoiceStatus {
        Pending,
        Sent,
        Paid,
        Canceled,
        AllUnpaid,
        All,
    }

KeyVisibility

public enum KeyVisibility {
        Private,
        Shared,
        Public,
        Session,
    }

ManifestType

 public enum ManifestType {
        System,
        Error,
        Manual,
        ECGridOS,
    }

MigrationStatus

public enum MigrationStatus {
        All,
        Canceled,
        Planned,
        Requested,
        Confirmed,
        Active,
        Completed,
    }

MigrationType

public enum MigrationType {
        Expected,
        Unexpected,
    }

MigrationTPStatus

public enum MigrationTPStatus {
        Pending,
        Inbound,
        Outbound,
        Complete,
    }

NetworkContactType

public enum NetworkContactType {
        Owner,
        Errors,
        Interconnects,
        Notices,
        Reports,
        Accounting,
        CustomerService,
    }

NetworkGatewayCommChannel

public enum NetworkGatewayCommChannel {
        none,
        ftp,
        sftp,
        as2,
        http,
        oftp,
        x400,
        gisb,
        rnif,
        undefined,
    }

NetworkGatewayConnection

public enum NetworkGatewayConnection {
        Internet,
        VPN,
        Dial,
        Other,
    }

NetworkGatewayHandshake

 public enum NetworkGatewayHandshake {
        Push,
        Pull,
        PushPull,
    }

NetworkLogStatus

public enum NetworkLogStatus {
        Start,
        CheckIn,
        Access,
        Pause,
        Restart,
        Shutdown,
        StatusChange,
    }

NetworkLogType

public enum NetworkLogType {
        SystemResponse,
        SystemAutomated,
        User,
    }

NetworkRoutingType

public enum NetworkRoutingType {
        Open,
        OpenWithSenderValidation,
        TradingPartnerPairs,
        MultiNetwork,
        ECGridOpen,
        ECGridTradingPartnerPairs,
    }

NetworkRunStatus

public enum NetworkRunStatus {
        Restart,
        OffLine,
        Active,
        Sleeping,
        Alert,
    }

NetworkServiceType

public enum NetworkServiceType {
        SVC,
        VAN,
        MBX,
        NET,
        APP,
        HUB,
    }

NetworkStatus

public enum NetworkStatus {
        Redirected,
        NormalOperation,
        ECGridScheduledOutage,
        ECGridUnscheduledOutage,
        NetworkScheduledOutage,
        NetworkUnscheduledOutage,
    }

NetworkType

public enum NetworkType {
        Network,
        Router,
    }

NetworkWebsiteType

public enum NetworkWebsiteType {
        Home,
        Support,
        Login,
    }

NetworkVPNEncryptionMethod

public enum NetworkVPNEncryptionMethod {
        _3DES_SHA1,
        _DES_SHA1,
        _3DES_MD5,
        _DES_MD5,
    }

Objects

public enum Objects {
        User,
        Network,
        Mailbox,
        ECGridID,
        Interconnect,
        Migration,
        Parcel,
        Interchange,
        CarbonCopy,
        CallBackEvent,
        AS2,
        GISB,
        ParcelNotes,
        InterconnectNote,
        PriceList,
        Contract,
        Invoice,
    }

OrderBy

public enum OrderBy {
        Description,
        QID,
    }

ParcelStatus

public enum ParcelStatus {
        InBoxReady,
        InBoxTransferred,
        x1256Pending,
        as2Receive,
        as2MDNSent,
        as2MDNPending,
        as2MDNRejected,
        as2MDNConfirmed,
        as2Sent,
        as2SendFailed,
        gisbReceived,
        gisbSent,
        gisbSendFailed,
    }

ParcelValid

public enum ParcelValid {
        Pending,
        Invalid,
        Valid,
        ValidPartialRouted,
        ValidNoneRouted,
    }

PricelistAccountReports

public enum PricelistAccountReports {
        FixedRate,
        Statistics,
        TrafficAll,
        TrafficIntraNetwork,
        TrafficInterECGrid,
        TrafficOffNetwork,
        TrafficSpecial,
    }

PricelistItemLevel

 public enum PricelistItemLevel {
        Additional,
        OneTime,
        General,
        Developement,
        Level1,
        Level2,
        Level3,
        Level4,
        Level5,
        Level6,
        Level7,
        Level8,
        Level9,
        Tier1,
        Tier2,
        Tier3,
        Tier4,
        Tier5,
        Tier6,
        Tier7,
        Tier8,
        Tier9,
    }

PricelistMeasureField

public enum PricelistMeasureField {
        Each,
        FixedRate,
        NewInterconnects,
        CurrentMailboxes,
        ActiveQIDs,
        ActiveTPs,
        TotalTrans,
        ToTrans,
        FromTrans,
        TotalKCs,
        ToKCs,
        FromKCs,
        RegisteredQIDs,
        RegisteredTPs,
        MigratedTPs,
        CreditPercentage,
        DebitPercentage,
        Subtotal,
	}

PricelistModel

public enum PricelistModel {
        Simple,
        Tiered,
        Stacked,
    }

ReceiptType

public enum ReceiptType {
        None,
        SynchronousUnsigned,
        SynchronousSigned,
        AsynchronousUnsigned,
        AsynchronousSigned,
    }

RetCode

 public enum RetCode {
        Unknown,
        Success,
        SesssionTimeout,
        AccessDenied,
        NotFound,
        InvalidID,
        Duplicate,
        IDExistsOnNetwork,
        InvalidDataType,
        InvalidDataLength,
        DataError,
        SQLError,
        InternalError,
    }

RoutingGroup

public enum RoutingGroup {
        ProductionA,
        ProductionB,
        Migration1,
        Migration2,
        NetOpsOnly1,
        NetOpsOnly2,
        ManagedFileTransfer,
        SuperHub,
        Test,
        Suspense1,
        Suspense2,
        Suspense3,
    }

SessionStatus

public enum SessionStatus {
        Open,
        Closed,
        Expired,
    }

StatisticsPeriod

public enum StatisticsPeriod {
        Hour,
        Day,
        Week,
        Month,
    }

Status

public enum Status {
        Development,
        Active,
        Preproduction,
        Suspended,
        Terminated,
    }

StatusCallBack

public enum StatusCallBack {
        Active,
        Pending,
        Completed,
        Error,
        Canceled,
    }

StatusECGridID

 public enum StatusECGridID {
        Active,
        AutoRoute,
        Pending,
        Suspended,
        Terminated,
        Duplicate,
    }

StatusInterconnect

public enum StatusInterconnect {
        Pending,
        Completed,
        Canceled,
        Delayed,
        Problem,
        AuthorizationRequired,
        NoStatusChange,
    }

UseType

public enum UseType {
        Undefined,
        Test,
        Production,
        TestAndProduction,
    }

Back To Appendix Home

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.