Web API

Enterprise extends EnterpriseInfo

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Method Summary
String getAddress()

Returns the address of the enterprise.

ArchiveManager getArchiveManager(String group)

Returns the transaction archive manager for the enterprise. The active user must have manageArchive permission for the group. Do not use * for group.

int getBillingDay()

Returns the day of the month billing occurs for this Enterprise.

String getCity()

Returns the city of the enterprise.

SystemDataView getConnectors()

Lists connectors for this enterprise. Active user must have manageServices permission.

String getCountry()

Returns the country of the enterprise.

String getCountryCode()

Returns the country code of the enterprise.

Data getData()

Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.

SystemDataView getDomains()

Returns a list of domains for this enterprise.

String getFax()

Returns the fax of the enterprise.

String getGlobalSetting(String name)

Returns the global setting identified by name. Returns null if no setting exists with that name.

String getId()

Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.

String getLanguage()

Returns the language of the enterprise.

String getName()

Returns the name of this enterprise.

String getPhone()

Returns the phone of the enterprise.

String getPostalCode()

Returns the postal code of the enterprise.

String getState()

Returns the state of the enterprise.

String getStateCode()

Returns the state code of the enterprise.

StorageProvider getStorageProvider(String name)

Returns storage provider registered for this enterprise.

DataList getStorageProviders()

Returns list of storage provider names and types registered for this enterprise.

String getTimeZone()

Returns the time zone of the enterprise.

String getTimeZoneCode()

Returns the time zone code of the enterprise.

boolean hasGroup(String name)

Returns whether or not this enterprise has the private group with the specified name.

boolean hasProfile(ProfileInfo profile)

Returns true if the Enterprise has a profile for the user associated with the user of the given profile.

boolean hasProfile(String email)

Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile

boolean hasSharedGroup(String name)
⚠Deprecated since 11-11-2014. No replacement

Returns whether or not this enterprise has the shared group with the specified name.

boolean isRegistered(String domain)

Returns true if the Enterprise domain has been registered with this enterprise.

boolean isSoftArchiveEnabled()

Returns true if the enterprise is enabled and configured for soft archive.

boolean isTimeZoneEnabled()

Returns true if time zone code of the enterprise is API enabled.

String toString()

Returns a description of this object.

Method Detail


String getAddress()

Returns the address of the enterprise.

Returns:  String

Since: 07-06-2009

top

ArchiveManager getArchiveManager(String group)

Returns the transaction archive manager for the enterprise. The active user must have manageArchive permission for the group. Do not use * for group.

Parameters:

  • String   group Required parameter.

Returns:  ArchiveManager

Since: 02-10-2012

top

int getBillingDay()

Returns the day of the month billing occurs for this Enterprise.

Returns:  int

Since: 05-30-2013

top

String getCity()

Returns the city of the enterprise.

Returns:  String

Since: 07-06-2009

top

SystemDataView getConnectors()

Lists connectors for this enterprise. Active user must have manageServices permission.

Returns:  SystemDataView


DataList Name: Connectors
Tag Support: No
DataList Keys/Column Name Column Type Read Only
name String  
type String  
active Boolean  
status String  
createDate Date  
modifiedDate Date  
firstName String  
lastName String  
email String  

Since: 05-16-2011

top

String getCountry()

Returns the country of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getCountryCode()

Returns the country code of the enterprise.

Returns:  String

Since: 07-06-2009

top

Data getData()

Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.

Returns:  Data

Since: 07-06-2009

top

SystemDataView getDomains()

Returns a list of domains for this enterprise.

Returns:  SystemDataView


DataList Name: Domains
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
domainName String  
active Boolean  

Since: 06-01-2011

top

String getFax()

Returns the fax of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getGlobalSetting(String name)

Returns the global setting identified by name. Returns null if no setting exists with that name.

Parameters:

  • String   name

Returns:  String

Since: 05-13-2008

top

String getId()

Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.

Returns:  String

Since: 08-12-2020

top

String getLanguage()

Returns the language of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getName()

Returns the name of this enterprise.

Returns:  String

Since: 07-06-2009

top

String getPhone()

Returns the phone of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getPostalCode()

Returns the postal code of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getState()

Returns the state of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getStateCode()

Returns the state code of the enterprise.

Returns:  String

Since: 07-06-2009

top

StorageProvider getStorageProvider(String name)

Returns storage provider registered for this enterprise.

Parameters:

  • String   name  - provider name. Required parameter.

Returns:  StorageProvider

Since: 02-10-2012

top

DataList getStorageProviders()

Returns list of storage provider names and types registered for this enterprise.

Returns:  DataList


DataList Name: providers
DataList Fields: name, type

Since: 02-10-2012

top

String getTimeZone()

Returns the time zone of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getTimeZoneCode()

Returns the time zone code of the enterprise.

Returns:  String

Since: 07-06-2009

top

boolean hasGroup(String name)

Returns whether or not this enterprise has the private group with the specified name.

Parameters:

  • String   name

Returns:  boolean

Since: 11-11-2009

top

boolean hasProfile(ProfileInfo profile)

Returns true if the Enterprise has a profile for the user associated with the user of the given profile.

Parameters:

Returns:  boolean

Since: 03-15-2007

top

boolean hasProfile(String email)

Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile

Parameters:

  • String   email  - profile email. Required parameter.

Returns:  boolean

Since: 12-22-2011

top

boolean hasSharedGroup(String name)

Returns whether or not this enterprise has the shared group with the specified name.

Parameters:

  • String   name

Returns:  boolean

Since: 11-11-2009

This method has been deprecated since 11-11-2014. No replacement

top

boolean isRegistered(String domain)

Returns true if the Enterprise domain has been registered with this enterprise.

Parameters:

  • String   domain

Returns:  boolean

Since: 03-15-2007

top

boolean isSoftArchiveEnabled()

Returns true if the enterprise is enabled and configured for soft archive.

Returns:  boolean

Since: 01-02-2021

top

boolean isTimeZoneEnabled()

Returns true if time zone code of the enterprise is API enabled.

Returns:  boolean

Since: 03-11-2022

top

String toString()

Returns a description of this object.

Returns:  String

Since: 08-29-2007

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM