Versions Compared

Old Version 30

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version 31

changes.mady.by.user Marios Michael

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

...

Expand
titleExample 1

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null"",
        "description": null"",
        "code": "OK"
    },
    "data":
    [
        {
            "family":
udf_string_10": null,
            "usage_service_catalogs_set":
            [
                {
                    "id": "9F9CF9074DB2406B994DD34EEAF44BA5",
                    "name": "Api Test",
                    "description": "Test Update From Api",
                    "alternative_code": "A_T"
                }
            ],
            "udf_float_1": null,
            "udf_string_11": null,
            "udf_float_2": null,
            "udf_string_12": null,
            "brand": null,
            "udf_float_3": null,
            "udf_string_13": null,
            "udf_float_4": null,
            "udf_string_14": 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":
            [
                {
                    "valid_from": "2015-09-01T00:00:00",
                    "valid_to": "2015-09-15T00:00:00"
                }
            ],
            "price_plans_set":
            [
                {
                    "effective_date": "2014-11-01T16:27:10",
                    "type": "CONDITIONAL",
                    "id": "76E6BC7F8D66F9F97466C457E97DAF72",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": "2015-09-17T00:00:00"
                },
                {
                    "effective_date": "2014-09-05T17:59:41",
                    "type": "CONDITIONAL",
                    "id": "124FF42485290166C9F53A4761AC05A0",
                    "name": "2313",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "asdas",
                    "expiration_date": "2015-06-25T00:00:00"
                },
                {
                    "effective_date": "2014-10-01T00:00:00",
                    "type": "BASE",
                    "id": "3A6ADF02D2FA95A12280B736610279FF",
                    "name": "Aluxsat BASIC Price PLan",
                    "description": "Pers",
                    "code": "ABPP",
                    "expiration_date": "2014-12-18T15:25:43"
                },
                {
                    "effective_date": "2014-08-05T00:00:00",
                    "type": "BASE",
                    "id": "B517A9F2D3E988F7321F2BDA9AC18051",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-08-07T00:00:00"
                },
                {
                    "effective_date": "2014-08-07T00:00:00",
                    "type": "BASE",
                    "id": "7CB9E81A214B0F25EEECE223B608DCCC",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-09-12T10:21:54"
                },
                {
                    "effective_date": "2014-08-04T00:00:00",
                    "type": "BASE",
                    "id": "B327AC0436E36F7C70B1CC50B795564D",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": "2014-08-05T00:00:00"
                },
                {
                    "effective_date": "2015-09-17T00:00:00",
                    "type": "CONDITIONAL",
                    "id": "031EFE5DDD874C56A0E68A0FC2961E70",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": null
                },
                {
                    "effective_date": "2014-10-27T15:41:29",
                    "type": "CONDITIONAL",
                    "id": "D2B34625C75671E53C2380E53531B9E1",
                    "name": "Aluxsat Conditional Price Plan",
                    "description": "Aluxsat Conditions",
                    "code": "AlxCPP",
                    "expiration_date": "2014-11-01T16:27:10"
                },
                {
                    "effective_date": "2014-12-18T15:25:43",
                    "type": "BASE",
                    "id": "F7C3E67460E445101E7642D2C8C60AF9",
                    "name": "Aluxsat BASIC Price PLan",
                    "description": "Pers",
                    "code": "ABPP",
                    "expiration_date": "2018-10-01T00:00:00"
                }
            ],
            "id": "17688F614343868F71F913924021415C",
            "family": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "3 Days Left",
            "log_information":
            {
                "updated_date": "2015-09-01T12:30:57",
                "created_date": "2014-08-04T14:25:02",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "vat_rate":
            {
                "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                "name": "Standard 10%",
                "description": null,
                "alternative_code": "S10"
            },
            "components_set":
            [
            ],
            "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"
            },
            "description": "3 Days Left",
            "alternative_code": "3DL",
            "categories_set":
            [
            ]
        },
        {
            "udf_string_10": null,
            "usage_service_catalogs_set":
            [
                {
                    "id": "C5C8A8B9691C469A813120EE648054F7",
                    "name": "34",
                    "description": null,
                    "alternative_code": "34"
                },
                {
                    "id": "9F9CF9074DB2406B994DD34EEAF44BA5",
                    "name": "Api Test",
                    "description": "Test Update From Api",
                    "alternative_code": "A_T"
                },
                {
                    "id": "57FD4AA45E024D2FA6D8A67B41967CF1",
                    "name": "Api Test 2",
                    "description": "Test From Api",
                    "alternative_code": "A_T_2"
                },
                {
                    "id": "65407FBD15184DEAA6E5AC84EEBD558D",
                    "name": "Exet Usage Catalog",
                    "description": null,
                    "alternative_code": "EUC"
                },
                {
                    "id": "61BEE068A3FE4E0A89A309A0C6632A68",
                    "name": "test",
                    "description": "test audit trail log",
                    "alternative_code": "T_1"
                },
                {
                    "id": "545BF62B72534BEAAFEC295CCCE9E248",
                    "name": "4176",
                    "description": null,
                    "alternative_code": "4"
                },
                {
                    "id": "5E5AD41E3939402085F421612C20B0A9",
                    "name": "test l",
                    "description": null,
                    "alternative_code": "tl"
                }
            ],
            "udf_float_1": null,
            "udf_string_11": null,
            "udf_float_2": null,
            "udf_string_12": null,
            "brand": null,
            "udf_float_3": null,
            "udf_string_13": null,
            "udf_float_4": null,
            "udf_string_14": 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": "02192DC60AF606C2124118AABCBFAAAA",
            "family": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Serendipity",
            "log_information":
            {
                "updated_date": "2014-08-04T14:25:53",
                "created_date": "2014-08-04T14:25:37",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429"
                {},
                "nameupdated_by_user": "LED TV",
                {
                    "idperson_name": "23B1B61652524515C440DF0CDC02E12Bpersy",
                    "descriptionusername": null"persy",
                    "codeid": "LET"3274FDE75239692B81B2526BC1A9E429"
                }
            },
            "brandvat_rate":
            {
                "nameid": "SamsungF170FB2FF32E8C4F5A569E8F3B461E1F",
                "idname": "E262BDC87F97B8DA8762D1507CCBF3C7Standard 10%",
                "description": null,
                "alternative_code": "SAMS10"
            },
            "idcomponents_set":
"599C2CE3A1E25F69A8E2A367474E4336",            [
"code": "SSTV0000452"         },  ],
      {
            "familytype":
            {
                "nameservice_type": "LED TVUSAGE",
                "idphysical_good_type": "23B1B61652524515C440DF0CDC02E12BNONTRACEABLE",
                "descriptionused_for_provisioning": nulltrue,
                "codeclassification": "LET"
       SERVICES",
    },             "brand":
            {composition_method": "FLAT",
                "nameid": "Samsung78F758444F6B8437F1A27F61D1BE84A5",
                "idname": "E262BDC87F97B8DA8762D1507CCBF3C7VOD",
                "description": null"Video on Demand Movies",
                "alternative_code": "SAMVOD"
            },
            "iddescription": "58DB60D0C959E2154B14CFA6EB90F88DSerendipity",
            "alternative_code": "SSTV0000453""SRDP",
            "categories_set":
            [
            ]
    }    },
	....
 ]
}