Page Comparison

Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_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

...

Name	Type	Description
token	String	The token retrieved from the login method
entity	String	The entity of the segments to be retrieved which can be CONTACT_INFORMATION, SUBSCRIPTIONS, ACCOUNTS_RECEIVABLE, BILLS, ACTIVITIES, JOBS
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

...

Name

Type

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_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

...

Name

Type

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_identifier

exceptional_items_set

(mandatory)

Set of Segmentation Exceptional Item Objects

The segment exceptional item objects to be updated

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

...

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

 {
"token":"3C5826900500C75CBA83DA6C89548E11",
"segmentation_identifier":{"number":"13"},
"exceptional_items_set":
        [
            {
                           "action": "add",
                           "entity_name":"BILL",
                           "entity_value":"9F3458A149723312CB477AF94AA896DF"
            }
        ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "log_information":
        {
            "updated_date": "2014-09-12T15:55:33",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-09-08T11:11:32",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "entity": "BILL",
        "life_cycle_state": "DRAFT",
        "number": "13",
        "exceptional_items":
        [
            {
                "bill":
                {
                    "total_amount_to_be_paid": 0,
                    "status": "SETTLED",
                    "to_date": null,
                    "from_date": "2013-05-23T00:00:00",
                    "life_cycle_state": null,
                    "total_billed_amount": 0,
                    "number": "000001",
                    "id": "D2EA952648ACAFA425669AB83BB7355F"
                },
                "id": "8375EB155D136F1C658BB67AA0BBF358"
            },
            {
                "bill":
                {
                    "total_amount_to_be_paid": 15,
                    "status": "UNSETTLED",
                    "to_date": null,
                    "from_date": "2013-05-27T00:00:00",
                    "life_cycle_state": null,
                    "total_billed_amount": 15,
                    "number": "000023",
                    "id": "620123243FFB6EA791D29DFF07BE4A31"
                },
                "id": "E40C7E59C810845987F6CD08B04A72D1"
            },
            {
                "bill":
                {
                    "total_amount_to_be_paid": 84.6,
                    "status": "UNSETTLED",
                    "to_date": null,
                    "from_date": "2013-05-23T00:00:00",
                    "life_cycle_state": null,
                    "total_billed_amount": 84.6,
                    "number": "000004",
                    "id": "9F3458A149723312CB477AF94AA896DF"
                },
                "id": "FCA008A037F183B10A1BB011F903E021"
            }
        ],
        "id": "C874E428073419A4D1195C747020F63F",
        "criteria": "random criteria",
        "alternative_code": "test"
    }
}

Versions Compared

Old Version 8

New Version 9

Key