Standard features are reusable templates that provide default values for features. See Standard Features for full details on how inheritance works.
Methods
GET
Retrieve Single Standard Feature
/backend/api/v1/standardFeatures/ID - fetch standard feature with specified ID.
List Standard Features
/backend/api/v1/standardFeatures/ - list all standard features.
POST
/backend/api/v1/standardFeatures/ - create a new standard feature. The newly-created standard feature will be returned.
PATCH
/backend/api/v1/standardFeatures/ID - update standard feature with specified ID. The modified standard feature will be returned.
DELETE
/backend/api/v1/standardFeatures/ID - delete standard feature with specified ID.
Note: A standard feature can only be deleted if no features are currently linked to it.
Actions
Actions are called by sending a POST request to /backend/api/v1/standardFeatures/ID/actionName.
applyIncrease
Applies a percentage price increase to the standard feature in-place. Requires expert level 5 access.
Parameters:
increasePercent(numeric, required): The percentage increase to apply (e.g. 3.5)increaseScope(string, required):recurringOnlyorrecurringAndConnections
Returns the updated standard feature.
createIncreaseVersion
Creates a new standard feature with prices increased by the specified percentage. The original standard feature is not modified.
Parameters:
increasePercent(numeric, required): The percentage increase to apply (e.g. 3.5)increaseScope(string, required):recurringOnlyorrecurringAndConnections
Returns the new standard feature, or an existing version if one with the same source, percentage, and scope already exists.
See Price Increases for full details, scope options, and examples.
Fields
| Field | Name | Type | Description |
|---|---|---|---|
| name | Name | Text | Name of this standard feature template |
| availability | Standard Feature Availability | Preset Value | Availability status controlling who can use this standard feature template |
| featureType | Feature Type | Preset Value | The type of service this standard feature template represents |
| description | Description | Text | Default description for features created from this template |
| customerProducts | Customer Products | Preset Value(s) | Default products to associate with features created from this template |
| featureCountCommittedAuto | Feature Auto Committed Count | Preset Value | Default automatic calculation method for committed count |
| totalFeatureValue | Total Feature Value | Currency | Default total value over the lifetime of features created from this template |
| instalments | Instalments | Number | Default number of instalments to split the total feature value |
| connectionTransactionType | Transaction Type (One-Off) | Preset Value | Default transaction type for one-off charges |
| connectionCharge | One-Off | Currency | Default one-off charge for features created from this template |
| connectionTransactionCode | Transaction Code (One-Off) | Text | Default transaction code for one-off charges |
| serviceTransactionType | Transaction Type (Recurring) | Preset Value | Default transaction type for recurring charges |
| serviceCharge | Recurring Charge (£) | Currency | Default recurring charge for features created from this template |
| serviceChargeInterval | S/C Interval | Text | Default frequency of recurring charges |
| serviceTransactionCode | Transaction Code (Recurring) | Text | Default transaction code for recurring charges |
| callsTransactionCode | Transaction Code (Calls) | Text | Default transaction code for call/usage charges |
| VATRate | VAT Rate | Preset Value | Default VAT rate for one-off and recurring charges |
| VATRateCalls | VAT Rate (Calls) | Preset Value | Default VAT rate for call/usage charges |
| initialFeatureDiscountScheme | Initial Discount Scheme | Preset Value | Default initial discount scheme for features created from this template |
| ongoingFeatureDiscountScheme | Ongoing Discount Scheme | Preset Value | Default ongoing discount scheme for features created from this template |
| fixedFeeTariff | Fixed Fee Tariff | Preset Value | Default fixed fee tariff for features created from this template |
| inboundTariff | Inbound | Preset Value | Tariff to use for inbound calls, overriding customer/number defaults |
| nationalTariff | National | Preset Value | Tariff to use for national calls, overriding customer/number defaults |
| mobileTariff | Mobile | Preset Value | Tariff to use for mobile calls, overriding customer/number defaults |
| nongeographicTariff | Non-geographic | Preset Value | Tariff to use for non-geographic calls, overriding customer/number defaults |
| serviceNumbersTariff | Service Numbers | Preset Value | Tariff to use for service numbers, overriding customer/number defaults |
| internationalTariff | International | Preset Value | Tariff to use for international calls, overriding customer/number defaults |
| extendedInternationalTariff | Extended International | Preset Value | Tariff to use for extended international calls, overriding customer/number defaults |
| surchargesTariff | Surcharges | Preset Value | Tariff to use for surcharges, overriding customer/number defaults |
| bespokeTariff1 | Bespoke Tariff 1 | Preset Value | Tariff to use for bespoke tariff 1, overriding customer/number defaults |
| bespokeTariff2 | Bespoke Tariff 2 | Preset Value | Tariff to use for bespoke tariff 2, overriding customer/number defaults |
| discountPlanMultiplier1 | Discount Plan 1 Multiplier | Number | Multiplier for the first discount plan |
| discountPlan1 | Discount Plan 1 | Preset Value | First discount plan to apply |
| discountPlanMultiplier2 | Discount Plan 2 Multiplier | Number | Multiplier for the second discount plan |
| discountPlan2 | Discount Plan 2 | Preset Value | Second discount plan to apply |
| discountPlanMultiplier3 | Discount Plan 3 Multiplier | Number | Multiplier for the third discount plan |
| discountPlan3 | Discount Plan 3 | Preset Value | Third discount plan to apply |
| discountPlanMultiplier4 | Discount Plan 4 Multiplier | Number | Multiplier for the fourth discount plan |
| discountPlan4 | Discount Plan 4 | Preset Value | Fourth discount plan to apply |
| carrier | Carrier | Preset Value | Default carrier for features created from this template |
| carrierProduct | Carrier Product | Text | Default carrier product code for features created from this template |
| carrierProductMatches | Carrier Product (Advanced Match) | Text | Default advanced matching pattern for carrier product codes |
| connectionChargeCarrier | Carrier One-Off Charge (£) | Currency | Default carrier one-off charge for features created from this template |
| serviceChargeCarrier | Carrier Recurring Charge (£) | Currency | Default carrier recurring charge for features created from this template |
| connectionChargeCommissionProfile | One-Off Commission Profile | Preset Value | Default commission profile for one-off charges |
| serviceChargeCommissionProfile | Recurring Commission Profile | Preset Value | Default commission profile for recurring charges |
| callChargeCommissionProfile | Call Commission Profile | Preset Value | Default commission profile for call/usage charges |
| connectionChargeCommission | One-Off Commission | Currency | Default commission amount for one-off charges |
| connectionChargeCommissionType | One-Off Commission Type | Preset Value | Default commission calculation method for one-off charges |
| serviceChargeCommission | Recurring Commission | Currency | Default commission amount for recurring charges |
| serviceChargeCommissionType | Recurring Commission Type | Preset Value | Default commission calculation method for recurring charges |
| connectionChargeCommission2 | One-Off Commission 2 | Currency | Default commission amount for one-off charges (secondary commission holder) |
| connectionChargeCommissionType2 | One-Off Commission Type 2 | Preset Value | Default commission calculation method for one-off charges (secondary commission holder) |
| serviceChargeCommission2 | Recurring Commission 2 | Currency | Default commission amount for recurring charges (secondary commission holder) |
| serviceChargeCommissionType2 | Recurring Commission Type 2 | Preset Value | Default commission calculation method for recurring charges (secondary commission holder) |
| renewalPeriodLength | Renewal Period Length | Number | Default renewal period length for features created from this template |
| renewalPeriodLengthType | Renewal Period Length Type | Preset Value | Default renewal period unit of time for features created from this template |
| minimumTermPeriodLength | Minimum Term Length | Number | Default minimum term length for features created from this template |
| minimumTermPeriodLengthType | Minimum Term Length Type | Preset Value | Default minimum term unit of time for features created from this template |
| committedTermPeriodLength | Committed Term Length | Text | Default committed term length for features created from this template |
| committedTermPeriodLengthType | Committed Term Length Type | Preset Value | Default committed term unit of time for features created from this template |
| noticePeriodLength | Notice Period Length | Number | Default notice period length for features created from this template |
| noticePeriodLengthType | Notice Period Length Type | Preset Value | Default notice period unit of time for features created from this template |
| increaseOriginalID | Original Standard Feature | Preset Value | Standard feature this increase was based upon (self for in-place increases) |
| increasePercent | Increase % | Number | Increase percentage applied to this standard feature template |
| id | Standard Feature ID | Text | The unique identifier for this standard feature template |