Rate Schedules

API for browsing, adding, editing and deleting Rate Schedules.

URLs

Rate Schedules

• GET /rateschedules
  Return a list of Rate Schedules.

• GET /rateschedules/{Id}
  Return a specific Rate Schedule.

• POST /rateschedules
  Create a new Rate Schedule.

• PUT /rateschedules
  Update an existing Rate Schedule.

• DELETE /rateschedules/{Id}
  Delete the specified Rate Schedule.

Rate Schedule Items

• GET /ratescheduleitems
  Return a list of Rate Schedule Items.

• GET /rateschedules/{RateScheduleId}/ratescheduleitems
  Return a list of Rate Schedule Items assigned to the specified Rate Schedule.

• GET /ratescheduleitems/{Id}
  Return a specific Rate Schedule Item.

• POST /ratescheduleitems
  Create a new Rate Schedule Item.

• PUT /ratescheduleitems/{Id}
  Update an existing Rate Schedule Item.

• DELETE /ratescheduleitems/{Id}
  Delete the specified Rate Schedule Item.

References

Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Copying a Resource
Updating a Resource
Deleting a Resource

Notes

Rate Schedule Copy Object

{
  "RateScheduleId": 1,
  "NewRateScheduleName": ""
}

Rate Schedule Object

{
  "RateScheduleId": 0,
  "RateSchedule": "",
  "Description": "",
  "BillingPackageId": 0,
  "BillingPackageName": "",
  "MobileChargeScheduleId": 0,
  "MobileChargeScheduleName": ""
}

Rate Schedule Item Object

{
  "RateScheduleItemId": 0,
  "RateScheduleId": 0,
  "RateScheduleName": "",
  "MobileChargeScheduleId": 0,
  "MobileChargeScheduleName": "",
  "Description": "",
  "Origin": "",
  "CallType": "ctAny",
  "MobileProfileId": 0,
  "MobileProfileName": "",
  "Dnis": "",
  "Ani": "",
  "StartDate": "",
  "EndDate": "",
  "DayRange": "",
  "StartTime": "",
  "EndTime": "",
  "Priority": 0,
  "Enabled": false,
  "RatePlanId": 0,
  "RatePlanName": "",
  "OverrideGracePeriod": false,
  "GracePeriod": 0,
  "OverrideMinSecsBilled": false,
  "MinSecsBilled": 0,
  "OverrideShortestCallAllowed": false,
  "ShortestCallAllowed": 0,
  "OverrideBillingDelay": false,
  "BillingDelay": 0,
  "OverrideRateInterval": false,
  "RateInterval": 0,
  "OverrideSpeakRateInterval": false,
  "SpeakRateInterval": false,
  "OverrideDisconnectCharge": false,
  "DisconnectCharge": 0,
  "DisconnectChargeType": "dctFixedAmount",
  "OverrideDisconnectChargeCallEnd": false,
  "DisconnectChargeCallEnd": false,
  "OverrideSpeakDisconnectCharge": false,
  "SpeakDisconnectCharge": false,
  "ThresholdType": "ttCalls",
  "ThresholdValue": 0
}

Table Definitions

RATE_SCHEDULES

Rate Schedules allow you to assign one or more Rate Schedule Items that consist of a rate plan that is scheduled based on time of day, day of week, call origination and call termination so that different plans become active depending on certain criteria being met. Through the use of Rate Schedules and Rate Schedule Items you can create peak, off peak, weekend and holiday rates with the server application managing when the various underlying rate plans become
effective.

RATE_SCHEDULE_ITEMS

Rate Schedule Items consist of a rate plan that is scheduled based on time of day, day of week, call origination and call termination so that different plans become active depending on certain criteria being met. Through the use of Rate Schedules and Rate Schedule Items you can create peak, off peak, weekend and holiday rates with the server application managing when the various underlying rate plans become effective.