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

...

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
 
  "statusdata": [
    {
 
      "messagedefault": ""false,

       "descriptionproduct_type": "",{
        "codeservice_type": "OKUSAGE",
    },
    "dataused_for_provisioning":  true,
  [         {"alternative_code": "V",
             "default"udr_type": false,
 {
          "productalternative_typecode": "V",
          "name": "VOD",
 {         "description": null,
          "service_typeid": "USAGEB3CFC986221548279752B1ABC6F4C480",
        },
        "physicalcomposition_good_typemethod": "NONTRACEABLEFLAT",
        "name": "Usage Services",
        "used_for_provisioningdescription": true,"Used for VOD , PPV, TELEPHONE CALLS ETC",
         "classificationid": "SERVICES751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "compositionphysical_good_methodtype": "FLAT",null
      }
    },
    "id{
      "default": "78F758444F6B8437F1A27F61D1BE84A5"true,
      "product_type": {
        "nameservice_type": "VODUSAGE",
        "used_for_provisioning": true,
        "descriptionalternative_code": "Video on Demand Movies",U-Fixed",
        "udr_type": {
          "alternative_code": "VODUT",
            }
"name": "UDR Type",
       },   "description": null,
    {      "id": "2596B027536040809599D4665AF1D528"
     "default": false,   },
         "productcomposition_typemethod": "FLAT",
        "name": "Usage - {Fixed B",
        "description": "Add a description of the new "service_typetype",
        "id": "USAGE2717F3F8A27444309F6AC1EA7D77D1A2",
        "classification": "SERVICES",
        "physical_good_type": null,
      }
    },
    {
    "used_for_provisioning  "default": truefalse,
      "product_type": {
        "classificationservice_type": "SERVICESUSAGE",
           "used_for_provisioning": true,
        "compositionalternative_methodcode": "FLATVS",
        "udr_type": {
          "idalternative_code": "219FBB8FBAA1433AB0A33446B61637F9V",
                "name": "Usage - FlatVOD",
  
             "description": "Usage - Flat"null,
            "id": "B3CFC986221548279752B1ABC6F4C480"
   "alternative_code": "U-F"    },
        }
"composition_method": "FLAT",
       }, "name": "VOD Service",
     {   "description": null,
        "defaultid": true"B06ACBEF10A24057902837A51BCB2B36",
            "product_type"classification": "SERVICES",
           {
                "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",
 "physical_good_type": null
      }
    }
  "description": "Usage - Fixed Bundle",
           ],
  "status": {
    "alternative_code": "U-FBOK",
    "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"
            }
        }
    ]
} 

...

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

Anchor
usage service catalog provisioning provider
usage service catalog provisioning provider
Referred Objects Response Data

Include Page
V4:provisioning_providers_short
V4:provisioning_providers_short

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

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