Page Comparison

Tip
Available from CRM.COM R9.0.0

Excerpt
This method returns information related with the CRM.COM product that is mapped into a perception package or contract. A single package is returned by each call

...

Name	Type	Description
token	String	The token retrieved from the login method
package_id (semi-optional)	String	The id of the perception package
contract_id (semi-optional)	String	The id of the perception contract
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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "usage_service_catalogs_set": [
      {
        "id": "E1EB5ECB33FB4F8AAE2722BA1E085A43",
        "name": "Perception catalog",
        "description": null,
        "alternative_code": "PC"
      },
      {
        "id": "B93B08A071A04C9792716E26262DCF73",
        "name": "Test Product",
        "description": null,
        "alternative_code": "TP"
      },
      {
        "id": "BA2F98BF66494A3584ABE9DA1747BA16",
        "name": "Catalog Story board 5",
        "description": null,
        "alternative_code": "Catalog_SB_5"
      },
      {
        "id": "F55FBE9B9AE94C8AAD12352AAC9D9AEA",
        "name": "Usage Service 4176",
        "description": "dfgdfg",
        "alternative_code": "US4"
      }
    ],
    "udf_string_10": null,
    "udf_string_11": null,
    "udf_float_1": null,
    "brand": null,
    "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": "33F396002DE74BB8BA5439CA943E7FEF",
    "family": null,
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "code": "Movie 2",
    "log_information": {
      "updated_date": "2015-09-11T14:20:08",
      "created_date": "2015-09-11T14:19:52",
      "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": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "components_set": [],
    "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"
    },
    "description": "Movie 2",
    "categories_set": [],
    "alternative_code": "MOV_2"
  }
}

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": {
        "code": "Bronze",
        "alternative_code": "B",
        "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": "2016-02-08T11:45:30",
            "updated_date": "2017-08-21T12:59:09",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "Eleni Michailidou",
                "id": "9A2CF58F91D94B8B981C33275BA20880",
                "email": "crm.com.tst@gmail.com",
                "username": "emichailidou"
            }
        },
        "components_set": [],
        "price_plans_set": [
            {
                "code": "PK Main",
                "name": "PK Main",
                "effective_date": "2017-02-06T00:00:00",
                "description": "Main Price Plan",
                "id": "9B9690AFD6914EBBB4BEB7A00AA76567",
                "type": "CONDITIONAL",
                "expiration_date": null
            },
            {
                "code": "DP",
                "name": "Daily Price",
                "effective_date": "2017-02-22T00:00:00",
                "description": null,
                "id": "A0A511F6589741E7AA27A7068FBFC52E",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "MPP",
                "name": "Main Price Plan",
                "effective_date": "2017-05-31T00:00:00",
                "description": "Main Price Plan",
                "id": "D48ADE1316F44DA6BBCDA7C4E654980A",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "ETPP",
                "name": "ET Price Plans",
                "effective_date": "2016-12-19T00:00:00",
                "description": null,
                "id": "10395E69DDDC4FBA83D94F07327E0598",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "CPricePlan",
                "name": "Currency Price Plan",
                "effective_date": "2016-07-19T00:00:00",
                "description": null,
                "id": "FF1F2341333E4D60857D35BD0EE807C3",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "ETNDPP",
                "name": "Price Plan No Extra Digits check ET",
                "effective_date": "2016-12-19T00:00:00",
                "description": null,
                "id": "ECFBE01D724C4FC89630EDF7DDC2A2A6",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "Price Plan Tax SK",
                "name": "PPT_SK",
                "effective_date": "2017-03-08T00:00:00",
                "description": "Regression Testing SK",
                "id": "237F2D87EFB94DE0B0A5AD3558681C6E",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "ETDPP",
                "name": "Digits check ET",
                "effective_date": "2016-12-19T00:00:00",
                "description": null,
                "id": "991F77149E82403BAF2FFA1B6949086B",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "Test FW changes",
                "name": "Test FW changes",
                "effective_date": "2016-12-06T00:00:00",
                "description": null,
                "id": "0F91BBAA241B41EFBBF4FCB270AF94F4",
                "type": "BASE",
                "expiration_date": null
            },
            {
                "code": "PPS6",
                "name": "Price Plan Storyboard 6",
                "effective_date": "2016-12-19T00:00:00",
                "description": null,
                "id": "EC5A38FD43DC41BDB16DE033FDD12D82",
                "type": "BASE",
                "expiration_date": null
            }
        ],
        "description": "Bronze",
        "udf_date_2": null,
        "type": {
            "service_type": "TERMED",
            "used_for_provisioning": true,
            "alternative_code": "Main Packages",
            "udr_type": null,
            "composition_method": "FLAT",
            "name": "Main Packages",
            "description": null,
            "id": "E186E293AAAB49EE86A729540A4287FE",
            "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,
        "bundle_restrictions": [
            {
                "number_of_product_families_restriction": 9,
                "number_of_product_types_restriction": 1
            }
        ],
        "id": "F50CC52934BD4F119B6E18E215A4FC55",
        "udf_string_10": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "brand": {
            "alternative_code": "C",
            "name": "CRM.COM",
            "description": null,
            "id": "24444B978542404192430E7B305BBB37"
        },
        "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": [],
        "tax_rate_set": [
            {
                "alternative_code": "STBC",
                "name": "Subscription Tax Big Cities",
                "description": null,
                "id": "FD53532A6BA14F2680AD9D0FF9953DB9"
            },
            {
                "alternative_code": "ST",
                "name": "Sales Tax",
                "description": null,
                "id": "E85BD1C608E64EB8820C2087982B303A"
            },
            {
                "alternative_code": "STSC",
                "name": "Subscription Tax Small Cities",
                "description": null,
                "id": "F5E66E601B154D60AD1E80B785E0292C"
            },
            {
                "alternative_code": "TT",
                "name": "Telephony Tax",
                "description": null,
                "id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
            }
        ],
        "vat_rate_set": [
            {
                "alternative_code": "S_1",
                "name": "Standard(VATS)",
                "description": null,
                "id": "D8159982FCBE4316BEAD4F6E761FB40D"
            }
        ],
        "udf_string_9": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 3

New Version Current

Key