Page Comparison

...

Tip
Available from R16R17.0.0

Excerpt
This method returns the customers that will be communicated through a specific communication plan.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

communication_plan_identifier

(mandatory)

Communication Plan Identifier

The identifier of the communication plan through which the customers returned as a result will be communicated. The allowed communication plan type identifier fields are the following:

Include Page

	V4:communication_plan_identifier
	V4:communication_plan_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

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

{
    "data": [
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M Rewards SB17",
                "id": "7AEBFF5C8C34448FA8654B422F9D056C"
            },
            "entity_id": "7AEBFF5C8C34448FA8654B422F9D056C"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 4",
                "id": "0192248B5CB345578ED1D925260EA112"
            },
            "entity_id": "0192248B5CB345578ED1D925260EA112"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 45",
                "id": "89336167176A45999334B2DA83D6ED5E"
            },
            "entity_id": "89336167176A45999334B2DA83D6ED5E"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 23",
                "id": "3CE4804F34AF45B190F37210C9D1C55E"
            },
            "entity_id": "3CE4804F34AF45B190F37210C9D1C55E"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 5",
                "id": "4352AA710FA9420BAD0D0221216E382D"
            },
            "entity_id": "4352AA710FA9420BAD0D0221216E382D"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M",
                "id": "167E80AF9B824576BAC1C4CA9D41BE72"
            },
            "entity_id": "167E80AF9B824576BAC1C4CA9D41BE72"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni 7 M",
                "id": "1CAFAD6BCCBA4F95BADABE858801C4CE"
            },
            "entity_id": "1CAFAD6BCCBA4F95BADABE858801C4CE"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M",
                "id": "52FED884646148DE88C44E8FC559A455"
            },
            "entity_id": "52FED884646148DE88C44E8FC559A455"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 6",
                "id": "465DDB38365D4867BAB40BB60235DC28"
            },
            "entity_id": "465DDB38365D4867BAB40BB60235DC28"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Reward Term",
                "id": "B650B51D04E746789177FDADAF7A2FD2"
            },
            "entity_id": "B650B51D04E746789177FDADAF7A2FD2"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Michailidou",
                "id": "E1C7F0E1FBE14D4CBFAC919841C17B2F"
            },
            "entity_id": "E1C7F0E1FBE14D4CBFAC919841C17B2F"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni222 Michailidou33",
                "id": "DE460C0D3D6C46DE8F3B8362262FCFDF"
            },
            "entity_id": "DE460C0D3D6C46DE8F3B8362262FCFDF"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni 8 M",
                "id": "B83F38F5B8D543C8965C2AB0A540F5E2"
            },
            "entity_id": "B83F38F5B8D543C8965C2AB0A540F5E2"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Michailidou APP",
                "id": "26278A567E704BD0BBD6C9EB468B67DB"
            },
            "entity_id": "26278A567E704BD0BBD6C9EB468B67DB"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M",
                "id": "25904102FD8142F98D03E7C4BBDE037F"
            },
            "entity_id": "25904102FD8142F98D03E7C4BBDE037F"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Term 3",
                "id": "52E093BD07084C4085F350592428FC4A"
            },
            "entity_id": "52E093BD07084C4085F350592428FC4A"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni 2 M",
                "id": "0AE357EA2F3241C3A6A941EE50ED645B"
            },
            "entity_id": "0AE357EA2F3241C3A6A941EE50ED645B"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M 2704 3",
                "id": "695C5066577A47CDBAC6CD52FFEB13AD"
            },
            "entity_id": "695C5066577A47CDBAC6CD52FFEB13AD"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni M",
                "id": "D1898CEBD21145A688974511C6C8EDB0"
            },
            "entity_id": "D1898CEBD21145A688974511C6C8EDB0"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Term 2",
                "id": "A6EDCF5166B54DD7B4DF88F749AE4030"
            },
            "entity_id": "A6EDCF5166B54DD7B4DF88F749AE4030"
        },
        {
            "entity_name": "Contact Information",
            "contact_information": {
                "name": "Eleni Mich",
                "id": "EE15F92F5AD9487692DA4DD34D35CA09"
            },
            "entity_id": "EE15F92F5AD9487692DA4DD34D35CA09"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
    "data": [
        {
            "entity_name": "Reward Offer 126",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "7D08625ED19842F89F3D68FD88E566D9"
        },
        {
            "entity_name": "Reward Offer 127",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "47448EDCC6FE4917AB3FADCC8E2B0012"
        },
        {
            "entity_name": "Reward Offer 311",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "658862169F664B15B1E28A87DE58C5FC"
        },
        {
            "entity_name": "Reward Offer 129",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "8F59DE7306254753ACA66722160F1B12"
        },
        {
            "entity_name": "Reward Offer 130",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "4ED1BB08CAE342AD8BA670CC797E377E"
        },
        {
            "entity_name": "Reward Offer 128",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "ECDCED992FE04C119829402368843B54"
        },
        {
            "entity_name": "Reward Offer 317",
            "contact_information": {
                "name": "Janet Iackson",
                "id": "C12540A0BE494FA0A3591D1ECDB174B1"
            },
            "entity_id": "DA7261DB31384C449E7CCA42F643AFD1"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

 {
    "data": [
        {
            "entity_name": "Subscription S0000000677",
            "contact_information": {
                "name": "pania member 1",
                "id": "0402B5941957416B8D7BEDEAF435C822"
            },
            "entity_id": "D3BF5E8910CF4AF68B5C57E3D78452BC"
        },
        {
            "entity_name": "Subscription S0000001035",
            "contact_information": {
                "name": "pania member 1",
                "id": "0402B5941957416B8D7BEDEAF435C822"
            },
            "entity_id": "9F6CC872D50643FC99BAF7C5AEC0530C"
        },
        {
            "entity_name": "Subscription S0000000811",
            "contact_information": {
                "name": "pania member 1",
                "id": "0402B5941957416B8D7BEDEAF435C822"
            },
            "entity_id": "4DF4F3724E15409CB08CC7E036615F73"
        },
        {
            "entity_name": "Subscription S0000001252",
            "contact_information": {
                "name": "Pania Account2",
                "id": "2DD368CEDCF74F2CBBD8B01941B4304A"
            },
            "entity_id": "09222F01301D4AF7921CD7AA828FEE3E"
        },
        {
            "entity_name": "Subscription S0000001251",
            "contact_information": {
                "name": "Pania Account1",
                "id": "BAB53C1C0831478E8CD57EED67FB75C4"
            },
            "entity_id": "95AD0AA433E64EE4AB3803C517058676"
        },
        {
            "entity_name": "Subscription S0000000808",
            "contact_information": {
                "name": "Pania Demou",
                "id": "D6704BA70E83472987C820FEE983BB6C"
            },
            "entity_id": "00959710314940B9B9D87B3E361892F2"
        },
        {
            "entity_name": "Subscription S0000000809",
            "contact_information": {
                "name": "Pania Demou",
                "id": "D6704BA70E83472987C820FEE983BB6C"
            },
            "entity_id": "55119B7D2FBB49699289E48D72D3F8B4"
        },
        {
            "entity_name": "Subscription S0000000810",
            "contact_information": {
                "name": "Pania Demou",
                "id": "D6704BA70E83472987C820FEE983BB6C"
            },
            "entity_id": "E18E90B41D824811AF2C192249C5F6CB"
        },
        {
            "entity_name": "Subscription S0000000678",
            "contact_information": {
                "name": "pania member 2",
                "id": "16DF98F5FB5A4446ACEF7D3D3591BC19"
            },
            "entity_id": "F99849FBCB8647B6A0C34FF8D0757904"
        },
        {
            "entity_name": "Subscription S0000001023",
            "contact_information": {
                "name": "pania member 2",
                "id": "16DF98F5FB5A4446ACEF7D3D3591BC19"
            },
            "entity_id": "EF9B9D0135D843D09E3928654E7571A5"
        },
        {
            "entity_name": "Subscription S0000000682",
            "contact_information": {
                "name": "pania parent",
                "id": "8700F7CB83394754A25BCE55C56EE6BF"
            },
            "entity_id": "E2D380C2DB0F4A6D9F3BEE98CD7970E9"
        },
        {
            "entity_name": "Subscription S0000000619",
            "contact_information": {
                "name": "Pania Demaki",
                "id": "7407BC18D3EC4B41B61265C629C0EEFB"
            },
            "entity_id": "C556AA0EAAC640D9981D3BF4072B4E5B"
        },
        {
            "entity_name": "Subscription S0000000893",
            "contact_information": {
                "name": "Pania Demaki",
                "id": "7407BC18D3EC4B41B61265C629C0EEFB"
            },
            "entity_id": "1165FABE97B44A418BEA6A26FF9A00C9"
        },
        {
            "entity_name": "Subscription S0000001011",
            "contact_information": {
                "name": "Pania Demou",
                "id": "BE7815CA60CD434698233839DF337D16"
            },
            "entity_id": "DDF57E2894E04E64A35823DCF50B3E77"
        },
        {
            "entity_name": "Subscription S0000001010",
            "contact_information": {
                "name": "Pania Demou",
                "id": "BE7815CA60CD434698233839DF337D16"
            },
            "entity_id": "449D10604C474A09ABC510F5C14A3717"
        },
        {
            "entity_name": "Subscription S0000001346",
            "contact_information": {
                "name": "Pania Demou",
                "id": "F03E3E882BDB4FD88C12222462800E12"
            },
            "entity_id": "2AF8467D3DE2418DA2B6662C7A05B8D2"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Versions Compared

Old Version 2

New Version 3

Key

Resource URL

Parameters

Restrictions