Page Comparison

...

Tip
Available from CRM.COM R8.0.0 Deprecated from CRM.COM R15.0.0

Excerpt
This method returns the rates of a specific usage service or any usage service which is included in a specific usage service catalog and are allowed to be used by subscribers, during the specified date. Multiple usage services rates are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

valid_as_of_date

(optional)

Date

If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. If not specified then the current date is considered as the valid as of date.

Tip
In releases previous to CRM.COM R14.2.0 this information is mandatory

usage_service_identifier

(semi-optional)

Usage Service Identifier

If specified then only usage services rates related with the specified usage service will be retrieved. The allowed usage service identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

usage_service_catalog_identifier

(semi-optional)

Usage Service Catalog Identifier

If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier

If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

Tip
Deprecated from CRM.COM R15.0.0

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

subscription_identifier

(optional)

Subscription Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

termed_service_identifier

(optional)

Product Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

group_identifier

(optional)

Group Identifier

The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

code

language

javascript
theme	Confluence
language	javascript
linenumbers	true

{
  "data": [
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-03-28T13:39:26",
        "updated_date": "2017-03-28T13:45:17",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "unit_of_measurement": {
        "alternative_code": "A",
        "name": "Amount",
        "description": null,
        "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
      },
      "udf_float_4": null,
      "id": "01509D2E150046D991447A390398E782",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "V for Vendetta",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": true,
          "alternative_code": "VS",
          "udr_type": {
            "alternative_code": "V",
            "name": "VOD",
            "description": null,
            "id": "B3CFC986221548279752B1ABC6F4C480"
          },
          "composition_method": "FLAT",
          "name": "VOD Service",
          "description": null,
          "id": "B06ACBEF10A24057902837A51BCB2B36",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "VFV",
        "description": "V for Vendetta VOD",
        "id": "FD50BBBFAC7245838F205F5C143F54AE"
      },
      "provisioning_id": "304",
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": null,
      "pre_rated": true,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-03-28T14:10:08",
        "updated_date": "2017-03-28T14:10:19",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "unit_of_measurement": {
        "alternative_code": "A",
        "name": "Amount",
        "description": null,
        "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
      },
      "udf_float_4": null,
      "id": "15481BBC87F44773BE8F1FEE699ACC39",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "V for Vendetta",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": true,
          "alternative_code": "VS",
          "udr_type": {
            "alternative_code": "V",
            "name": "VOD",
            "description": null,
            "id": "B3CFC986221548279752B1ABC6F4C480"
          },
          "composition_method": "FLAT",
          "name": "VOD Service",
          "description": null,
          "id": "B06ACBEF10A24057902837A51BCB2B36",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "VFV",
        "description": "V for Vendetta VOD",
        "id": "FD50BBBFAC7245838F205F5C143F54AE"
      },
      "provisioning_id": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": null,
      "pre_rated": true,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

code

language

javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "rate": 26,
            "minimum_usage": 1,
            "maximum_usage": 15,
            "source_category":
            {
                "name": "United Kingdom",
                "id": "3107A54E4DD840DA93A452B12CEF2246",
                "description": "United Kingdom",
                "code": "UK"
            },
            "device":
            {
                "name": "STB",
                "id": "FF9922EF7C43474AA5C6AD07A3911DA5",
                "description": null,
                "alternative_code": "STB"
            },
            "usage_start_time": "null:null",
            "id": "85CD14CF5BEA427D8E0BCCF898410AAA",
            "usage_end_time": "null:null",
            "usage_method":
            {
                "name": "Rental",
                "id": "250B5CB790CA4344A27299962868C57D",
                "description": "rental",
                "alternative_code": "rl"
            },
            "destination_category":
            {
                "name": "Voip Application",
                "id": "629C2E9E7B044012B0534787974E9D7C",
                "description": "VOIP APPLICATION",
                "code": "VOIP"
            }
        },
        {
            "rate": 45,
            "minimum_usage": null,
            "maximum_usage": null,
            "source_category":
            {
                "name": "VoiP Application",
                "id": "F504F4E00C724E9AB0C412EF0C0369D4",
                "description": "VoiP Application",
                "code": "VOIP"
            },
            "device":
            {
                "name": "Tablet",
                "id": "ACDED1DC999A4FB1AC375622CD1C6147",
                "description": "Tablet",
                "alternative_code": "Tablet"
            },
            "usage_start_time": "1:0",
            "id": "78867FDE96B64725885B79F922652D93",
            "usage_end_time": "9:15",
            "usage_method":
            {
                "name": "Download",
                "id": "665FCE1AF41F44CB87A74CD9E769C488",
                "description": "Download",
                "alternative_code": "Download"
            },
            "destination_category":
            {
                "name": "United Kingdom",
                "id": "B1B639D5526A4EA0A205DA649F30077D",
                "description": "UNITED KINGDOM",
                "code": "UK"
            }
        },
        {
            "rate": 26,
            "minimum_usage": 1,
            "maximum_usage": 15,
            "source_category":
            {
                "name": "United Kingdom",
                "id": "3107A54E4DD840DA93A452B12CEF2246",
                "description": "United Kingdom",
                "code": "UK"
            },
            "device":
            {
                "name": "STB",
                "id": "FF9922EF7C43474AA5C6AD07A3911DA5",
                "description": null,
                "alternative_code": "STB"
            },
            "usage_start_time": "null:null",
            "id": "3DE50B14250E44EC947B94BFC99141C1",
            "usage_end_time": "null:null",
            "usage_method":
            {
                "name": "Rental",
                "id": "250B5CB790CA4344A27299962868C57D",
                "description": "rental",
                "alternative_code": "rl"
            },
            "destination_category":
            {
                "name": "Voip Application",
                "id": "629C2E9E7B044012B0534787974E9D7C",
                "description": "VOIP APPLICATION",
                "code": "VOIP"
            }
        }
    ]
}

...

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

code

Code Block

language

javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "data": [
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-05-11T15:51:30",
        "updated_date": "2017-05-12T15:05:38",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "71187B1A53904566BDABF838311BF849",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Serendipity",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": true,
          "alternative_code": "V",
          "udr_type": {
            "unit_of_measurement": null,
            "alternative_code": "V",
            "name": "VOD",
            "description": null,
            "id": "B3CFC986221548279752B1ABC6F4C480"
          },
          "composition_method": "FLAT",
          "name": "Usage Services",
          "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
          "id": "751C638AA3534B768408AAC4D73CF516",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "S_1",
        "description": "VOD: Serendipity ",
        "id": "BD3ACEE7D6244DCAA375D0744DA75540"
      },
      "provisioning_id": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [
        {
          "minimum_usage": 101,
          "maximum_usage": 200,
          "usage_start_time": null,
          "rate": 1.055,
          "source_category": null,
          "usage_end_time": null,
          "usage_method": null,
          "id": "E074C097CA7B47568377FD62D41B6393",
          "device": null,
          "destination_category": null
        },
        {
          "minimum_usage": 1,
          "maximum_usage": 100,
          "usage_start_time": null,
          "rate": 1.056,
          "source_category": null,
          "usage_end_time": null,
          "usage_method": null,
          "id": "A9B08C4D087E442CAD73FE955E259E04",
          "device": null,
          "destination_category": null
        }
      ],
      "base_rate": 5,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-05-11T16:26:19",
        "updated_date": "2017-05-11T16:32:49",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": true,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "5668DC76868A4EEAAAA6CDEC485F7D77",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Petrol",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "EP",
        "description": "Petrol",
        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 0.5,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-05-11T16:26:50",
        "updated_date": "2017-05-11T16:27:35",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "D5C736D9C2B245029ADBC47C92822554",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Unleaded",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "EU",
        "description": "Exxon Unleaded",
        "id": "3F174D8E87474A2AB115A2BFD2750FBB"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 1,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2017-05-11T16:33:42",
        "updated_date": "2017-05-11T16:33:48",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": true,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "E7F1ABB30B71457C9229CC40ADE55494",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Super",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "ES",
        "description": "Exxon Super Unleaded",
        "id": "056447D7931F49D49970D8753AA97688"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 0.75,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions