Page Comparison

Excerpt
This method returns information related with an installed item. A single installed item is returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

installed_item_identifier

(mandatory)

Identifier

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

Include Page

	V4:installed_item_identifier
	V4:installed_item_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

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
        "data":
        {
            "notes": null,
            "alternative_code": "Item11 - Product1",
            "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-10-24T13:22:19",
                "updated_date": "2017-10-24T13:42:25",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "components_set":
            [
            ],
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "id": "6AA921821A0D4F5F98A4C7B4A1C8638A",
            "state": "EFFECTIVE",
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "total_meter_reading": 120,
            "udf_string_3": null,
            "udf_string_4": null,
            "product":
            {
                "code": "Product1 - ProductType1",
                "product_type":
                {
                    "meter_reading_type":
                    {
                        "unit_of_measurement":
                        {
                            "alternative_code": "K",
                            "name": "Kwh",
                            "description": null,
                            "id": "515ED68956BE4C2F8FFFA0CC239E2957"
                        },
                        "alternative_code": "O",
                        "name": "OneTimeMRType",
                        "description": null,
                        "id": "60DDDE4D46EC48B1B6E85885367B8780",
                        "classification": "ONE_TIME_READING"
                    },
                    "service_type": null,
                    "used_for_provisioning": false,
                    "alternative_code": "P-O",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "ProductType1 - OneTimeMRType",
                    "description": null,
                    "id": "90532785266D44C8AD789E3410022E99",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "P-P",
                "description": "Product1 - ProductType1",
                "id": "52A2315A7DE541EAA1900BEE7BACB75E",
                "priority_level": null
            },
            "udf_string_5": null,
            "udf_string_1": null,
            "serial_number": "Item11 - Product1",
            "ownership_information":
            {
                "subscription":
                {
                    "number": "S0000009268",
                    "first_activated_date": "2017-10-24T13:42:24",
                    "rating_state": "PENDING",
                    "accounts_receivable":
                    {
                        "number": "ACR0000012788",
                        "name": "ACR0000012788 Test 7738_06",
                        "id": "04184E056A24484B9DB306A64A73C696",
                        "life_cycle_state": "ACTIVE",
                        "account_owner":
                        {
                            "company_profile": null,
                            "company_name": null,
                            "name": "Test 7738_06",
                            "last_name": "7738_06",
                            "id": "E398A7774D224DE9822C3C067C334274",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": null,
                            "title": null,
                            "type": "PERSON",
                            "first_name": "Test",
                            "demographics":
                            {
                                "name_day":
                                {
                                    "month": null,
                                    "day": null
                                },
                                "id_number": "7738_06",
                                "gender": null,
                                "country_of_residence":
                                {
                                    "alternative_code": "CYP",
                                    "three_character_code": "CYP",
                                    "name": "CYPRUS",
                                    "id": "181",
                                    "two_character_code": "CY"
                                },
                                "date_of_birth":
                                {
                                    "month": null,
                                    "year": null,
                                    "day": null
                                },
                                "industry_sector": null,
                                "passport_number": null,
                                "industry": null,
                                "social_security_number": null,
                                "id_issued_by_country": null,
                                "passport_issued_by_country": null
                            }
                        }
                    },
                    "id": "B53350A85831459E89F2A7E51FD08030",
                    "life_cycle_state": "EFFECTIVE",
                    "type":
                    {
                        "alternative_code": "normalsub",
                        "name": "Normal",
                        "description": null,
                        "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                    }
                },
                "job": null,
                "ownership_transferred": null,
                "ownership_status": "RENTED_TO_CUSTOMER"
            },
            "provisioning_provider_parameters_set":
            [
            ],
            "meter_reading_set":
            [
                {
                    "udr":
                    {
                        "number": "2274",
                        "subscription_service":
                        {
                            "product":
                            {
                                "code": "Gold",
                                "product_type":
                                {
                                    "meter_reading_type": null,
                                    "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
                                },
                                "alternative_code": "G",
                                "description": "Gold",
                                "id": "D1EB074DFD904E54A0C67CAB9DC7E010",
                                "priority_level": null
                            },
                            "rating_state": "PENDING",
                            "id": "147E11C430CF40048BE07314DAA71767",
                            "life_cycle_state": null
                        },
                        "product":
                        {
                            "code": "Usage2-Litre",
                            "product_type":
                            {
                                "meter_reading_type": null,
                                "service_type": "USAGE",
                                "used_for_provisioning": false,
                                "alternative_code": "U_2",
                                "udr_type":
                                {
                                    "unit_of_measurement":
                                    {
                                        "alternative_code": "L_1",
                                        "name": "Litre",
                                        "description": null,
                                        "id": "6571B6FE392645318B7EBD9F918960D3"
                                    },
                                    "alternative_code": "U_1",
                                    "name": "UDR2-Litre",
                                    "description": null,
                                    "id": "ABF0BEBE518C45AD80628890DAC03AD1"
                                },
                                "composition_method": "FLAT",
                                "name": "Usage2-Litre",
                                "description": null,
                                "id": "D1EF0D9DA6A44762913C5C9BFD8708A0",
                                "classification": "SERVICES",
                                "physical_good_type": null
                            },
                            "alternative_code": "U_1",
                            "description": "Usage2-Litre",
                            "id": "D555EB6194E64CBB8738DF060F5C05C7",
                            "priority_level": null
                        },
                        "from_date": "2017-10-22T19:00:00",
                        "to_date": "2017-10-22T20:00:00",
                        "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-10-24T16:36:20",
                            "updated_date": "2017-10-24T16:36:20",
                            "updated_by_user":
                            {
                                "person_name": "CRM COM",
                                "id": "1",
                                "email": "dev@crm.com",
                                "username": "MPAdministrator"
                            },
                            "created_by_user":
                            {
                                "person_name": "CRM COM",
                                "id": "1",
                                "email": "dev@crm.com",
                                "username": "MPAdministrator"
                            }
                        },
                        "source_system": null,
                        "id": "BB704B8846D6457DA652040BC800248D",
                        "usage_amount": 60,
                        "type":
                        {
                            "alternative_code": "U_1",
                            "name": "UDR2-Litre",
                            "description": null,
                            "id": "ABF0BEBE518C45AD80628890DAC03AD1"
                        }
                    },
                    "unit_of_measurement":
                    {
                        "alternative_code": "L_1",
                        "name": "Litre",
                        "description": null,
                        "id": "6571B6FE392645318B7EBD9F918960D3"
                    },
                    "from_date": "2017-10-22T19:00:00",
                    "to_date": "2017-10-22T20:00:00",
                    "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-10-24T16:36:20",
                        "updated_date": "2017-10-24T16:36:20",
                        "updated_by_user":
                        {
                            "person_name": "CRM COM",
                            "id": "1",
                            "email": "dev@crm.com",
                            "username": "MPAdministrator"
                        },
                        "created_by_user":
                        {
                            "person_name": "CRM COM",
                            "id": "1",
                            "email": "dev@crm.com",
                            "username": "MPAdministrator"
                        }
                    },
                    "accounts_receivable":
                    {
                        "number": "ACR0000012788",
                        "name": "ACR0000012788 Test 7738_06",
                        "id": "04184E056A24484B9DB306A64A73C696",
                        "life_cycle_state": "ACTIVE",
                        "account_owner":
                        {
                            "company_profile": null,
                            "company_name": null,
                            "name": "Test 7738_06",
                            "last_name": "7738_06",
                            "id": "E398A7774D224DE9822C3C067C334274",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": null,
                            "title": null,
                            "type": "PERSON",
                            "first_name": "Test",
                            "demographics":
                            {
                                "name_day":
                                {
                                    "month": null,
                                    "day": null
                                },
                                "id_number": "7738_06",
                                "gender": null,
                                "country_of_residence":
                                {
                                    "alternative_code": "CYP",
                                    "three_character_code": "CYP",
                                    "name": "CYPRUS",
                                    "id": "181",
                                    "two_character_code": "CY"
                                },
                                "date_of_birth":
                                {
                                    "month": null,
                                    "year": null,
                                    "day": null
                                },
                                "industry_sector": null,
                                "passport_number": null,
                                "industry": null,
                                "social_security_number": null,
                                "id_issued_by_country": null,
                                "passport_issued_by_country": null
                            }
                        }
                    },
                    "id": "66E27177DDC649B4849F4B9D05D7030B",
                    "meter_reading_value": 120
                }
            ],
            "udf_string_6": null,
            "category": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true


    {
        "data":
        {
            "notes": null,
            "alternative_code": "SM-MA-20003",
            "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-11-10T16:55:48",
                "updated_date": "2017-11-10T18:08:09",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "components_set":
            [
            ],
            "warehouse_issue_date": "2017-11-10T18:08:09",
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "warranty_policy":
            {
                "number": "8",
                "alternative_code": "JW",
                "name": "Job Warranty",
                "id": "94AFDC6E8F2F43599DB02BBF5F62C41F",
                "life_cycle_state": "EFFECTIVE"
            },
            "termed_services_distribution_set":
            [
                {
                    "subscription_service":
                    {
                        "product":
                        {
                            "code": "Bronze",
                            "product_type":
                            {
                                "meter_reading_type": null,
                                "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
                            },
                            "alternative_code": "B",
                            "description": "Bronze",
                            "id": "F50CC52934BD4F119B6E18E215A4FC55",
                            "priority_level": null
                        },
                        "first_activated_date": "2017-11-10T17:41:30",
                        "rating_state": "PENDING",
                        "service_bundle": null,
                        "rated_up_to_date": null,
                        "id": "CE5CBF51D05A4771AF81E8B159E7EF9F",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "provisioning_distributor":
                    {
                        "alternative_code": "CWM",
                        "name": "CONAX WEB MAIN",
                        "id": "EBF0CB9F8C91420DBA1B630A011F230B"
                    },
                    "provisioning_distributor_labels": null,
                    "id": "AD286CB44FE240A0B2A7712D3EE6F1AD"
                },
                {
                    "subscription_service":
                    {
                        "product":
                        {
                            "code": "Gold",
                            "product_type":
                            {
                                "meter_reading_type": null,
                                "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
                            },
                            "alternative_code": "G",
                            "description": "Gold",
                            "id": "D1EB074DFD904E54A0C67CAB9DC7E010",
                            "priority_level": null
                        },
                        "first_activated_date": "2017-11-10T18:08:02",
                        "rating_state": "PENDING",
                        "service_bundle": null,
                        "rated_up_to_date": null,
                        "id": "2081A59EF8FC43B7AFC4B6F5D8B06B1A",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "provisioning_distributor":
                    {
                        "alternative_code": "CWM",
                        "name": "CONAX WEB MAIN",
                        "id": "EBF0CB9F8C91420DBA1B630A011F230B"
                    },
                    "provisioning_distributor_labels": null,
                    "id": "F630AA53CEE64E6D8DC1507563131D02"
                },
                {
                    "subscription_service":
                    {
                        "product":
                        {
                            "code": "Silver",
                            "product_type":
                            {
                                "meter_reading_type": null,
                                "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
                            },
                            "alternative_code": "SLV",
                            "description": "SILVER",
                            "id": "AF390B58BCE646D485EAC39D44C2C81C",
                            "priority_level": null
                        },
                        "first_activated_date": "2017-11-10T18:08:02",
                        "rating_state": "PENDING",
                        "service_bundle": null,
                        "rated_up_to_date": null,
                        "id": "8D7CC4E65E904056A08206C122D66185",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "provisioning_distributor":
                    {
                        "alternative_code": "CWM",
                        "name": "CONAX WEB MAIN",
                        "id": "EBF0CB9F8C91420DBA1B630A011F230B"
                    },
                    "provisioning_distributor_labels": null,
                    "id": "FB22C842768F4173A25A7FBA300D1A8B"
                }
            ],
            "id": "5754B6733C1A4EE5BCEE1289674366E0",
            "state": "EFFECTIVE",
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "product":
            {
                "code": "Smartcard",
                "product_type":
                {
                    "meter_reading_type": null,
                    "service_type": null,
                    "used_for_provisioning": true,
                    "alternative_code": "S",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "SMARTCARD",
                    "description": "SMARTCARD",
                    "id": "D6BE0209EC0149989A89972CE889DF8B",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "S",
                "description": "Smartcard",
                "id": "4F656ED5DAC44168B0805227881202CD",
                "priority_level": null
            },
            "udf_string_5": null,
            "udf_string_1": null,
            "serial_number": "SM-MA-20003",
            "ownership_information":
            {
                "subscription":
                {
                    "number": "S0000009395",
                    "first_activated_date": "2017-11-10T17:41:30",
                    "rating_state": "PENDING",
                    "accounts_receivable":
                    {
                        "number": "ACR0000012950",
                        "name": "ACR0000012950 MA API Swap 1",
                        "id": "6530F8694D6549BF87D2FD522AB73E09",
                        "life_cycle_state": "ACTIVE",
                        "account_owner":
                        {
                            "company_profile": null,
                            "company_name": null,
                            "name": "MA API Swap 1",
                            "last_name": "Swap 1",
                            "id": "86D163FF00A942BD85D370CF5642910E",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": null,
                            "title": null,
                            "type": "PERSON",
                            "first_name": "MA API",
                            "demographics":
                            {
                                "name_day":
                                {
                                    "month": null,
                                    "day": null
                                },
                                "id_number": "6878978",
                                "gender": null,
                                "country_of_residence":
                                {
                                    "alternative_code": "CYP",
                                    "three_character_code": "CYP",
                                    "name": "CYPRUS",
                                    "id": "181",
                                    "two_character_code": "CY"
                                },
                                "date_of_birth":
                                {
                                    "month": null,
                                    "year": null,
                                    "day": null
                                },
                                "industry_sector": null,
                                "passport_number": null,
                                "industry": null,
                                "social_security_number": null,
                                "id_issued_by_country": null,
                                "passport_issued_by_country": null
                            }
                        }
                    },
                    "id": "1F1A6C4FB8B64302BBD4F3600284784F",
                    "life_cycle_state": "EFFECTIVE",
                    "type":
                    {
                        "alternative_code": "CP001",
                        "name": "Christina Package 1",
                        "description": null,
                        "id": "71305CFCCDE9453CA4475BEA14A5E9B2",
                        "classification": "PACKAGE"
                    }
                },
                "job": null,
                "ownership_transferred": null,
                "ownership_status": "OWNED_BY_CUSTOMER"
            },
            "provisioning_provider_parameters_set":
            [
            ],
            "meter_reading_set":
            [
            ],
            "udf_string_6": null,
            "category": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

Versions Compared

Old Version 5

New Version Current

Key