Available from CRM.COM R8.0.0

GET usage_service_catalogs/configuration/usage_service_types/list

This method returns the usage service types that are allowed to be used in usage service catalogs, based on the active usage service catalog definition. Multiple usage service types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Name	Type	Description
default	Boolean	The default usage service type
type	Usage Service Type Object	The related usage service type

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET usage_service_catalogs/configuration/provisioning_providers/list

This method returns the provisioning providers that are allowed to be used in usage service catalogs, based on the active usage service catalog definition. Multiple provisioning providers are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Name	Type	Description
default	Boolean	The default provisioning provider
type	Usage Service Type Object	The related provisioning provider

Referred Objects Response Data

provisioning_provider object response data

Name	Type	Description
id	String	The id of the retrieved provisioning provider
name	String	The name of the retrieved provisioning provider
alternative_code	String	The alternative code of the retrieved provisioning provider
description	String	The description of the retrieved provisioning providers
provisioning_protocol	String	The provisioning protocol used by the provisioning provider

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "type":
            {
                "provisioning_protocol": "EXSET_SMS_SERVICES",
                "id": "1007A2DB26CF47E396E210FE85EFF839",
                "name": "Exset",
                "description": "Exset
Oracle XE 10.2",
                "alternative_code": "XE"
            }
        },
        {
            "default": false,
            "type":
            {
                "provisioning_protocol": "NAGRAVISION_SMSgw_SERVICES",
                "id": "955DCBFC9F3B4F30A49FC08060539F20",
                "name": "Nagravision SMSgw Services1",
                "description": "Nagra_SMSgw  10.0.3.248   16777218
16777219
16777220
16777221
16777223",
                "alternative_code": "Nagra_SMSgw"
            }
        },
        {
            "default": true,
            "type":
            {
                "provisioning_protocol": "CONAX_CONTEGO_WEB_SERVICES",
                "id": "9C4930E3523BD2C8F0B513035322C423",
                "name": "CONAX V5",
                "description": "CONAX Contego 3.0 Web Services
connectSMS: Use to test the CA PIN update command
smsWs06: All othe",
                "alternative_code": "CV5"
            }
        },
        {
            "default": false,
            "type":
            {
                "provisioning_protocol": "PANACCESS_SERVICES",
                "id": "CC07D62510BBB940AC0BE4F54F84DFFA",
                "name": "Panaccess CableView",
                "description": "Panaccess CableView",
                "alternative_code": "PCV"
            }
        }
    ]
}