Service Allotment

The service allotment object stores information about the service allotments for a company.

Usage

The Service Allotment service is only accessible to users with the Manage Company privilege.

There is only one method, ServiceAllotmentQueryPage, which returns the service allotment data for the company.

There are various elements of the ListOfServiceAllotment argument that specify the service allotment data, as follows:

• Name. The allotment name.

• Value. The value set for the allotment by Customer Care

• CurrentUsage. The amount of the allotment currently used.

• AlertThreshold. The threshold value at which a warning email is sent.

• AlertEnabled. Whether an alert is enabled for the allotment.

• EmailAlertList. The email addresses of the users who will receive a warning email.

• AllotmentEmailSentDate. The date when an email notifying full usage of the allotment was sent.

• ThresholdEmailSentDate. The date when a warning email for the allotment was sent.

• DisplayName. The allotment name in the language currently active for the company.

• AllotmentUnit. The allotment unit of measure.

• AllotmentType. The type of allotment.

• RemainingUsage. The amount of the allotment remaining.

• Description. A description of the allotment.

• ListOfAllotmentUsage. The allotment usage data, which consists of the following:

  • AggregationType. The aggregation type.

  • AggregationPeriodTotalUsage. The total usage in the aggregation period.

  • AggregationPeriodTimestamp. The aggregation period.

  • AllotmentLimitId. The value set for the allotment by Customer Care.

  • AllotmentUnit. The allotment unit of measure.

  • AllotmentType. The allotment type.

  • AllotmentLimitName. The allotment name.

  • AllotmentLimitDisplayName. The allotment name in the language currently active for the company.

There are also various audit fields returned. For more information about administration of service allotments, see Oracle CRM On Demand Online Help.

Methods Called

The following table details the methods called by the Service Allotment service.

Table Methods Called by Service Allotment Service

Method	Name as Defined in Service
QueryPage	ServiceAllotmentQueryPage

Fields

The following table details the user keys for the service allotment object.

Table User Keys for the Service Allotment Object

Field Name
Name