Page Comparison

...

Available from CRM.COM R4.0.0

Tip
Excerpt
This method returns the latest notifications having a communication created and also pending in the communication queue. Multiple notifications are returned by each call.

Tip
Deprecated from R17.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Notification type identifier

The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:

Include Page

	V4:notification_type_identifier
	V4:notification_type_identifier

notification_run_identifier

(semi-optional)

Notification run identifier

The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:

Include Page

	V4:notification_run_identifier
	V4:notification_run_identifier

Tip
Deprecated from CRM.COM R12.0.0

communication_queue_external_system_identifier

(optional)

Communication Queue External System Identifier

The identifier of the external system that should process the notification communication through the communication queue. The allowed communication queue external system identifier fields are the following:

Include Page

	V4:communication_queue_external_system_identifier
	V4:communication_queue_external_system_identifier

contact_information_identifier

(optional)

Contact Information identifier

The identifier of the contact information notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

number

(mandatory)

Number

The number of notifications to be retrieved, starting from the latest one

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.

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "63",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "kosta",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": null,
                "type": "PERSON",
                "first_name": "kostas",
                "name": "kostas kosta",
                "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "country_of_residence":
                    {
                        "name": "JAPAN",
                        "id": "237"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": null,
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "kosta",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "kostas",
                    "name": "kostas kosta",
                    "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "JAPAN",
                            "id": "237"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "103",
                "name": "kostas1",
                "id": "F5190A359F5FD678AC55CFE368676A3D"
            },
            "id": "FC106FA2D781910E1A02A7331D4756DB",
            "items_set":
            [
                {
                    "estimated_consumption_date": null,
                    "entity_value": "DE3EF0FDA61B38A87200B71ECDB889D9",
                    "unsettled_amount": 18714.67,
                    "entity_name": "SUBSCRIPTIONS",
                    "id": "686A4F810E4C8E65804818ED70F83728",
                    "outstanding_amount": 18714.67,
                    "estimated_consumption_days": null,
                    "notified_amount": 18714.67
                }
            ],
            "total_notified_amount": 18714.67,
            "udf_date_1": null,
            "communication_queue":
            {
                "external_system":
                {
                    "name": "New Test",
                    "id": "86F416641DB5E549D230C010302E9666",
                    "alternative_code": "NT"
                },
                "life_cycle_state": "PENDING",
                "communication":
                {
                    "life_cycle_state": "COMPLETED",
                    "number": "117",
                    "id": "7B423B4163CB1B5889235FEF4F9250DB",
                    "contact_information":
                    {
                        "last_name": "kosta",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "kostas",
                        "name": null,
                        "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "passport_number": null,
                            "social_security_number": null,
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    }
                },
                "number": "44",
                "id": "C572ADB944858D7432119925186F725E"
            },
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-10-19T12:16:17",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-19T12:15:56",
                "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"
                }
            },
            "life_cycle_state": "PENDING",
            "unsettled_amount": 18714.67,
            "notification_run":
            {
                "end_date": "2014-10-19T12:16:18",
                "life_cycle_state": "COMPLETED",
                "number": "309",
                "start_date": "2014-10-19T12:15:54",
                "id": "352F7AB4F1F04046686FBB71ED57F354"
            },
            "total_outstanding_amount": 18714.67,
            "type":
            {
                "classification": "FINANCIAL",
                "name": "Subscription",
                "id": "A7323954167D42CC35EB846B153D91A3",
                "description": null,
                "alternative_code": "Subscription"
            }
        }
    ]
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions