Page Comparison

Tip
Available from CRM.COM R14.0.0

Excerpt
This method adjusts the updates a meter readings reading of an installed itemInstalled Item. A single installed itemInstalled Item's meter reading information is updated by each call. Applicable only for Installed Items that their Meter Reading Type is classified as ONETIME

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

installed_item_identifier

(mandatorysemi-optional)

Identifier

The identifier of the installed item that should be returned as a resultInstalled Item that a meter reading will be updated. The allowed installed item identifier fields are the following:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

Note: installed_item_identifier and meter_reading_identifier parameters are semi-optional

meter_reading_setidentifier

(applicable on conditionssemi-optional)

Set of Meter Reading ObjectsIdentifier

The meter readings that were documented for the related installed item

Applicable only for installed items that are not in a warehouse

If no records are specified in the set then nothing will be updated. To add a record use "action" : "add", to update a record use "action": "update" and to remove a record use "action" : "remove".

Different actions can be used within the same set. For example:identifier of the meter reading. The allowed meter reading identifier fields are the following:

Include Page

	V4:meter_reading_identifier
	V4:meter_reading_identifier

Note: installed_item_identifier and meter_reading_identifier parameters are semi-optional

meter_reading_value

(semi-optional)

Number

The meter reading value that was documented.

Note: meter_reading_value, from_date and to_date parameters are semi-optional

from_date

(semi-optional)

Date

The starting date of the period related with the meter reading

If not specified, then this parameter will be set as the To date of the previous entry (if any) - otherwise will be set as the current date

Note: meter_reading_value, from_date and to_date parameters are semi-optional

to_date

(semi-optional)

Date

The ending date of the period related with the meter reading

Note: meter_reading_value, from_date and to_date parameters are semi-optional

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified

Response Data

Include Page

	V4:installed_item_meter_reading_short
	V4:installed_item_meter_reading_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTUwODg1NDU1NSIsImlhdCI6IjE1MDg4NDczNTUiLCJqdGkiOiI2NTlCQTE2MTNEMzY0OUI3ODBBOUJENEIwQzIwMDA2OSJ9.i7632RZEY9eI-iQLLOh5NRorLx4xzqXh6zblZlasbHs",
"meter_reading_identifier":{"id":"DEA230783CF846BDA022A6BE641F0D00"},
"meter_reading_value":"100"
}

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

    {
        "data":
        {
            "udr":
            {

...

number": "

...

2267",
                "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",

...

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

...

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

  "priority_level": null
                    },
                    "first_activated_date": "2017-10-24T13:42:24",
                    "rating_state": "PENDING",
                    "service_bundle": null,
                    "rated_up_to_date": null,
                    "id": "147E11C430CF40048BE07314DAA71767",
                    "life_cycle_state": "EFFECTIVE"
                },
                "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
                },
                "installed_item":
                {
                    "product":
                    {
                        "code": "Product1 - ProductType1",
                        "product_type":
                        {
                            "meter_reading_type":
                            {
                                "unit_of_measurement": null,
                                "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
                    },
                    "alternative_code": "Item11 - Product1",
                    "serial_number": "Item11 - Product1",
                    "id": "6AA921821A0D4F5F98A4C7B4A1C8638A",
                    "state": "EFFECTIVE"
                },
                "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-24T15:30:04",
                    "updated_date": "2017-10-24T15:30:05",
                    "updated_by_user":
                    {
                        "person_name": "CRM COM",
                        "id": "1",
                        "username": "MPAdministrator"
                    },
                    "created_by_user":
                    {
                        "person_name": "CRM COM",
                        "id": "1",
                        "username": "MPAdministrator"
                    }
                },
                "source_system": null,
                "id": "29BBD6F552574909BE8F622112DBBDD1",
                "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-24T15:07:44",
            "to_date": "2017-10-24T16: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-24T15:29:18",
                "updated_date": "2017-10-24T15:30:06",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "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": "DEA230783CF846BDA022A6BE641F0D00",
            "meter_reading_value": 100
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

Versions Compared

Old Version 7

New Version Current

Key

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples