Versions Compared

Old Version 31

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 32

changes.mady.by.user Marina Antoniadou (Unlicensed)

Saved on

Key

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

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

product_identifier

(mandatory)

Identifier  

The identifier of the product that should be returned as a result. The allowed product identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

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

...

Include Page
V4:product_complete
V4:product_complete

Examples

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "code": "V for Vendetta",
    "alternative_code": "VFV",
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2017-03-10T13:13:57",
      "updated_date": "2017-03-10T13:17:33",
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "components_set": [],
    "price_plans_set": [],
    "description": "V for Vendetta VOD",
    "udf_date_2": null,
    "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
    },
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "udf_float_3": null,
    "udf_float_4": null,
    "udf_string_15": null,
    "categories_set": [],
    "udf_string_16": null,
    "udf_string_13": null,
    "validity_set": [],
    "udf_string_14": null,
    "udf_string_11": null,
    "udf_string_12": null,
    "id": "FD50BBBFAC7245838F205F5C143F54AE",
    "udf_string_10": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "brand": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_1": null,
    "udf_string_6": null,
    "family": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "usage_service_catalogs_set": [
      {
        "alternative_code": "T_1",
        "name": "Test MA",
        "description": null,
        "id": "6266FE95E731484E82263A9A69331095"
      },
      {
        "alternative_code": "NPTM",
        "name": "No Provider Test MA",
        "description": null,
        "id": "B71A453D29474A0B96A37F82D8B0B329"
      },
      {
        "alternative_code": "UTM",
        "name": "USC Test MA",
        "description": null,
        "id": "EE4119049F7F4D8A90E381A68B35B00A"
      }
    ],
    "udf_string_9": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}       
Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
		 "usage_service_catalogs_set":
         [
		 ],
		"udf_string_10": null,
        "udf_string_11": null,
        "udf_float_1": null,
        "brand":
        {
            "name": "Samsung",
            "id": "E262BDC87F97B8DA8762D1507CCBF3C7",
            "description": null,
            "alternative_code": "SAM"
        },
        "udf_string_12": null,
        "udf_float_2": null,
        "udf_string_13": null,
        "udf_float_3": null,
        "udf_string_14": null,
        "udf_float_4": null,
        "udf_string_15": null,
        "udf_string_1": null,
        "udf_string_16": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null,
        "validity_set":
        [
        ],
        "price_plans_set":
        [
        ],
        "id": "A2B00E27070BEB1B1273733260A45ACC",
        "family":
        {
            "name": "Movie Packages 3",
            "id": "226492B49E346D0C3236EC740E7509F4",
            "description": "Pay-TV",
            "code": null
        },
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "code": "Athina STB",
        "log_information":
        {
            "updated_date": "2014-11-12T14:09:08",
            "created_date": "2012-06-29T14:04:36",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            }
        },
        "vat_rate":
        {
            "name": "Low",
            "id": "D7325EE39EEB46EF0BE628239F88C882",
            "description": null,
            "alternative_code": "LOW"
        },
        "components_set":
        [
        ],
        "type":
        {
            "physical_good_type": "TRACEABLE",
            "service_type": null,
            "used_for_provisioning": true,
            "composition_method": "FLAT",
            "classification": "PHYSICALGOODS",
            "name": "Decoders",
            "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
            "description": "Decoders",
            "alternative_code": "D"
        },
        "description": "Athina STB",
        "categories_set":
        [
            {
                "id": "37D7C2B9C1012296BB1763ACADEA8807",
                "category":
                {
                    "name": "Residential 2",
                    "id": "12BE7A9BC9CE6A189C268F6440A60AB2",
                    "description": "Residential 2",
                    "code": "22"
                }
            }
        ],
        "alternative_code": "A-STB"
    }
}



     

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

(semi-optional)

Identifier

The identifier of the product type related with the products that will be returned as results. The allowed product type identifier fields are the following:

Include Page
V4:product_type_identifier
V4:product_type_identifier

brand_identifier

(semi-optional)

Identifier

The identifier of the product brand related with the products that will be returned as results. The allowed product brand identifier fields are the following:

Include Page
V4:product_brand_identifier
V4:product_brand_identifier

family_identifier

(semi-optional)

Identifier

The identifier of the product family related with the products that will be returned as results. The allowed product family identifier fields are the following:

Include Page
V4:product_family_identifier
V4:product_family_identifier

category_identifier

(semi-optional)

Identifier

The identifier of the product category related with the products that will be returned as results. The allowed product category identifier fields are the following:

Include Page
V4:product_category_identifier
V4:product_category_identifier

as_of_date_valid

(optional)

Date

Returns only the products that are valid based on specific date

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

...