Skip to end of banner
Go to start of banner

usage_service_catalogs/configuration

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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

defaultBooleanThe default usage service type
typeUsage Service Type ObjectThe related usage service type

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "78F758444F6B8437F1A27F61D1BE84A5",
                "name": "VOD",
                "description": "Video on Demand Movies",
                "alternative_code": "VOD"
            }
        },
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            }
        },
        {
            "default": true,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FIXEDBUNDLE",
                "id": "42BC31C8B56F4DE4846D4394BDC0B3EE",
                "name": "Usage - Fixed B",
                "description": "Usage Fixed Bundle product",
                "alternative_code": "U-Fixed"
            }
        },
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FIXEDBUNDLE",
                "id": "72C8E3CEB3547751264491200E5F690D",
                "name": "Usage - Fixed Bundle",
                "description": "Usage - Fixed Bundle",
                "alternative_code": "U-FB"
            }
        }
    ]
} 
 Example 2

HTTP Method: GET

 

Request:

Response:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": "NONTRACEABLE",
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "78F758444F6B8437F1A27F61D1BE84A5",
                "name": "VOD",
                "description": "Video on Demand Movies",
                "alternative_code": "VOD"
            }
        },
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            }
        },
        {
            "default": true,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FIXEDBUNDLE",
                "id": "42BC31C8B56F4DE4846D4394BDC0B3EE",
                "name": "Usage - Fixed B",
                "description": "Usage Fixed Bundle product",
                "alternative_code": "U-Fixed"
            }
        },
        {
            "default": false,
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FIXEDBUNDLE",
                "id": "72C8E3CEB3547751264491200E5F690D",
                "name": "Usage - Fixed Bundle",
                "description": "Usage - Fixed Bundle",
                "alternative_code": "U-FB"
            }
        }
    ]
} 

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

defaultBooleanThe default provisioning provider
typeUsage Service Type ObjectThe 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

descriptionStringThe description of the retrieved provisioning providers
provisioning_protocolStringThe provisioning protocol used by the provisioning provider

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "provisioning_provider":
            {
                "provisioning_protocol": "EXSET_SMS_SERVICES",
                "id": "1007A2DB26CF47E396E210FE85EFF839",
                "name": "Exset",
                "description": "Exset
Oracle XE 10.2",
                "alternative_code": "XE"
            }
        },
        {
            "default": false,
            "provisioning_provider":
            {
                "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,
            "provisioning_provider":
            {
                "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,
            "provisioning_provider":
            {
                "provisioning_protocol": "PANACCESS_SERVICES",
                "id": "CC07D62510BBB940AC0BE4F54F84DFFA",
                "name": "Panaccess CableView",
                "description": "Panaccess CableView",
                "alternative_code": "PCV"
            }
        }
    ]
} 
  • No labels