Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R8.0.0

Table of Contents
maxLevel2

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": [
    {
      "default": false,
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "udr_type": {
          "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
      }
    },
    {
      "default": true,
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "U-Fixed",
        "udr_type": {
          "alternative_code": "UT",
          "name": "UDR Type",
          "description": null,
          "id": "2596B027536040809599D4665AF1D528"
        },
        "composition_method": "FLAT",
        "name": "Usage - Fixed B",
        "description": "Add a description of the new type",
        "id": "2717F3F8A27444309F6AC1EA7D77D1A2",
        "classification": "SERVICES",
        "physical_good_type": null
      }
    },
    {
      "default": false,
      "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
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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

...

Examples

...

titleExample 1

HTTP Method: GET

 

Request:

Response:

 

...

themeConfluence
languagejavascript
linenumberstrue

...

Panel
nameblue

Child pages (Children Display)
excerpttrue