GET api/tariff?IsExactNameMatch={IsExactNameMatch}&TariffName={TariffName}&TariffCode={TariffCode}&Costinterrate={Costinterrate}&Decimalplaces={Decimalplaces}&Mobile={Mobile}&Roundup={Roundup}&MobileNetwork={MobileNetwork}&RetailId={RetailId}&PerSecondBilling={PerSecondBilling}&BaseTariff={BaseTariff}&BaseMarkup={BaseMarkup}&LongTariff={LongTariff}&MinCharge={MinCharge}&MinConnectionFee={MinConnectionFee}&MaxCharge={MaxCharge}&LongChange={LongChange}&ServiceCharge={ServiceCharge}&PerCallPerTimeband={PerCallPerTimeband}&ApplyConnectionAfterFreeMins={ApplyConnectionAfterFreeMins}&IsObsolete={IsObsolete}&TariffType={TariffType}&Consumer={Consumer}&AccessCharge={AccessCharge}&Buy={Buy}&LastUpdated={LastUpdated}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IsExactNameMatch | Specify whether the searched name matches the Tariff exactly | boolean |
None. |
| TariffName | The name of the returned tariff | string |
None. |
| TariffCode | The Tariff Code of the returned tariff | integer |
None. |
| Costinterrate | Applies when a call spans over two timebands (peak and offpeak) if true the cost of the call will at the starting rate. | boolean |
None. |
| Decimalplaces | The number of decimal places to the penny | integer |
None. |
| Mobile | Indicates whether the tariff is a mobile tariff | boolean |
None. |
| Roundup | Indicates whether the tariif always round up to the nearest penny | boolean |
None. |
| MobileNetwork | The name of the mobile network | string |
None. |
| RetailId | The retail ID. Used on buy tariffs for mobile calls and service charges | string |
None. |
| PerSecondBilling | Indicates whether calls are billed in increments (e.g. every one minute). | boolean |
None. |
| BaseTariff | The ID that the tariff is based upon | integer |
None. |
| BaseMarkup | A percentage value. A mark up of the tariff thta it is based on | decimal number |
None. |
| LongTariff | The ID of the tariff to switch to in case of a long call | integer |
None. |
| MinCharge | This allows for the setting of a Minimum Call Charge. This means that a call lasting one second will cost the specified minimum amount regardless of the cost per minute | boolean |
None. |
| MinConnectionFee | Sets a Connection Free for the tariff | boolean |
None. |
| MaxCharge | Sets a maximum call charge on a call regardless of the cost per minute | boolean |
None. |
| LongChange | Indicates whether any long call will change tariff | boolean |
None. |
| ServiceCharge | Indicates whether the tariff is a service charge tariff | boolean |
None. |
| PerCallPerTimeband | Allows a tariff to be set so that it applies different minimum, maximum and connection fee for each time band | boolean |
None. |
| ApplyConnectionAfterFreeMins | This specifies whether to appy the connection fee after the free minutes have been calculated | boolean |
None. |
| IsObsolete | indicates whether the Tariff is obsolete | boolean |
None. |
| TariffType | The type of tariff | integer |
None. |
| Consumer | Indicates whether tariff is a consumer tariff | boolean |
None. |
| AccessCharge | The access charge for the tariff | boolean |
None. |
| Buy | Indicates whether the tariff is a buy Tariff | boolean |
None. |
| LastUpdated | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Tariff| Name | Description | Type | Additional information |
|---|---|---|---|
| TariffName | The name of the returned tariff | string |
None. |
| TariffCode | The Tariff Code of the returned tariff | integer |
None. |
| Costinterrate | Applies when a call spans over two timebands (peak and offpeak) if true the cost of the call will at the starting rate. | boolean |
None. |
| Decimalplaces | The number of decimal places to the penny | integer |
None. |
| Mobile | Indicates whether the tariff is a mobile tariff | boolean |
None. |
| Roundup | Indicates whether the tariff always rounds up to the nearest penny | boolean |
None. |
| MobileNetwork | The name of the mobile network | string |
None. |
| RetailId | The retail ID. Used on buy tariffs for mobile calls and Service Charges | string |
None. |
| PerSecondBilling | Indicates whether calls are billed in increments (e.g. every one minute). | boolean |
None. |
| BaseTariff | The ID that the tariff is based upon | integer |
None. |
| BaseMarkup | A percentage value. A mark up of the tariff thta it is based on | decimal number |
None. |
| LongTariff | The ID of the tariff to switch to in case of a long call | integer |
None. |
| MinCharge | This allows for the setting of a Minimum Call Charge. This means that a call lasting one second will cost the specified minimum amount regardless of the cost per minute | boolean |
None. |
| MinConnectionFee | Sets a Connection Free for the tariff | boolean |
None. |
| MaxCharge | Sets a maximum call charge on a call regardless of the cost per minute | boolean |
None. |
| LongChange | Indicates whether any long call will change tariff | boolean |
None. |
| ServiceCharge | Indicates whether the tariff is a Service Charge tariff | boolean |
None. |
| PerCallPerTimeband | Allows a tariff to be set so that it applies different minimum, maximum and connection fee for each time band | boolean |
None. |
| ApplyConnectionAfterFreeMins | This specifies whether to appy the connection fee after the free minutes have been calculated | boolean |
None. |
| IsObsolete | indicates whether the Tariff is obsolete | boolean |
None. |
| TariffType | The tariff type | integer |
None. |
| Consumer | Indicates whether tariff is a consumer tariff | boolean |
None. |
| AccessCharge | The access charge for the tariff | boolean |
None. |
| Buy | Indicates whether this is a buy tariff | boolean |
None. |
| LastUpdated | The date/time that the tariff was last updated | date |
None. |