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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "logudf_float_information1":  null,
      {    "udf_float_2": null,
        "updatedudf_float_date3": "2014-09-09T17:19:43", null,
        "number": "14",
        "createdudf_byfloat_unit4": null,
        "udf_string_1": null,
 {       "udf_string_2": null,
        "communityudf_string_name3": null,
"Main Community",       "udf_string_4": null,
        "groupudf_string_name5": "Main Group"null,
        "udf_string_6": null,
      "name  "udf_string_7": "Admin Unit",null,
        "udf_string_8": null,
        "id": "48305F8849E3C18B227C5BE3A27BA6DFA718F14BB72DD5B0951F5BB41ED09403",
        "criteria": "random criteria",
        "descriptionentity": "r1SUBSCRIPTION",
        "udf_date_1": null,
        "alternativeudf_date_code2": "MG" null,
        "udf_date_3": null,
     },   "udf_date_4": null,
        "createdlog_dateinformation":
        {
            "updated_date": "2014-09-08T1115T11:1107:3202",
            "updatedcreated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_userdate": "2014-09-09T18:24:05",
            "updated_by_unit":
            {
                "personcommunity_name": "MPAdministratorMain Community",
                "usernamegroup_name": "MPAdministratorMain Group",
                "idname": "1Marketing Unit",
                "emailid": "mp@ministrator.com83922FE923563679768A94F58CAB5569",
                "description": "r1c1",
                "alternative_code": null
            },
            "updatedcreated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
             },"updated_by_user":
         "entity": "BILL",  {
      "life_cycle_state": "DRAFT",         "numberperson_name": "13csrtest",
        "exceptional_items":        "username": "csrtest",
[             {   "id": "BFF291E518D0BFA061EC6ECCD386BCA1",
            "bill":    "email": "csrtest@crm.com"
           { }
          },
        "totallife_amount_to_be_paidcycle_state": 15,"POSTED",
        "exceptional_items":
        [
       "status": "UNSETTLED",    {
                "toentity_datevalue": null,
  "4AB934541D55D9321473EBB4923515C1",
                 "fromentity_datename": "2013-05-27T00:00:00",
 "SUBSCRIPTIONS",
                  "life_cycle_state"id": null,"54FF66E68D1312E0DDBEF5B25E5999CB"
            },
       "total_billed_amount": 15,    {
                "numberentity_value": "0000238DD369DC4853C63C9BE19ADA4FC0A867",
   
                "identity_name": "620123243FFB6EA791D29DFF07BE4A31"
                }SUBSCRIPTIONS",
                "id": "E40C7E59C810845987F6CD08B04A72D1BC77F7D331D7AFB1435E0FBB46CD6107"
            },
            {
                "billentity_value": "F8B3A0426CCE4FAC8D8118DFC18073D5",
               { "entity_name": "SUBSCRIPTIONS",
                "id":  "total_amount_to_be_paid": 0,"447254BAB06D0203EC9CE206331FFB92"
             },
       "status": "SETTLED",    {
                "toentity_datevalue": null,
   "A60B45D48F24CE3C1099FEB5D4FCEC2E",
                "fromentity_datename": "2013-05-23T00:00:00SUBSCRIPTIONS",
   
                "life_cycle_stateid": null,"0A17A1800EC7F6DA2C4878F354503BBE"
            }
       "total_billed_amount": 0 ],
           "description": null,
        "numberalternative_code": "000001sts",
        }
}

GET segmentation/list

This method returns information related with a segmentation. Multiple communications are returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
entity (mandatory)	String	The entity of the segments to be retrieved which can be CONTACTINFORMATION, SUBSCRIPTIONS,ACCOUNTSRECEIVABLE, BILLS, ACTIVITIES, JOBS, REWARDPARTICIPANTS, REWARDAWARDTRANSACTIONS, REWARDSPENDTRANSACTIONS, SERVICEREQUESTS
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

Include Page

	V4:segmentation_complete
	V4:segmentation_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2014-09-08T10:53:14",
                "idcreated_by_unit":
  "D2EA952648ACAFA425669AB83BB7355F"              {
   },                 "idcommunity_name": "8375EB155D136F1C658BB67AA0BBF358Main Community",
            }         ],"group_name": "Main Group",
                    "idname": "C874E428073419A4D1195C747020F63FAdmin Unit",
                    "criteriaid": "random criteria48305F8849E3C18B227C5BE3A27BA6DF",
           "alternative_code": "test"     }
}

GET segmentation/list

This method returns information related with a segmentation. Multiple communications are returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
entity (mandatory)	String	The entity of the segments to be retrieved which can be CONTACTINFORMATION, SUBSCRIPTIONS,ACCOUNTSRECEIVABLE, BILLS, ACTIVITIES, JOBS, REWARDPARTICIPANTS, REWARDAWARDTRANSACTIONS, REWARDSPENDTRANSACTIONS, SERVICEREQUESTS
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: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-09-08T10:41:25",
           {     "statusupdated_by_unit":
                {
                    "messagecommunity_name": "Main nullCommunity",
          "description": null,         "codegroup_name": "OK"Main Group",
              },      "dataname":     [
"Admin Unit",
       {             "log_informationid":  "48305F8849E3C18B227C5BE3A27BA6DF",
          {                 "updated_date"description": "2014-09-08T10:53:14r1",
                    "createdalternative_by_unitcode": "MG"
               { },
                   "community_name": "Main Community","created_by_user":
                    "group_name": "Main Group",{
                    "person_name": "Admin UnitMPAdministrator",
                    "idusername": "48305F8849E3C18B227C5BE3A27BA6DFMPAdministrator",
                    "descriptionid": "r11",
                    "alternative_codeemail": "MGmp@ministrator.com"
                },
                "createdupdated_by_dateuser": "2014-09-08T10:41:25",
                {
    "updated_by_unit":                 {"person_name": "MPAdministrator",
                    "community_nameusername": "Main CommunityMPAdministrator",
                    "group_nameid": "Main Group1",
                    "nameemail": "Admin Unit","mp@ministrator.com"
                }
            },
            "identity": "48305F8849E3C18B227C5BE3A27BA6DFBILL",
            "life_cycle_state": "POSTED",
            "descriptionnumber": "r112",
            "exceptional_items":
       "alternative_code": "MG"    [
            }],
            "id": "34DBE1B8FAF5656003C4533F0D283921",
  "created_by_user":          "criteria": "ee",
     {       "alternative_code": "st1",
			"udf_float_1": null,
  	        "personudf_float_name2": "MPAdministrator"null,
 	        "udf_float_3": null,
 	        "usernameudf_float_4": "MPAdministrator"null,
 	        "udf_string_1": null,
 	        "idudf_string_2": "1"null,
 	        "udf_string_3": null,
 	        "emailudf_string_4": "mp@ministrator.com"
null,
	        "udf_string_5":        },null,
	        "udf_string_6": null,
	        "updatedudf_bystring_user7": null,
	        "udf_string_8": null,
	     {   "udf_date_1": null,
	        "udf_date_2": null,
	        "personudf_date_name3": "MPAdministrator"null,
	        "udf_date_4": null		
	 },
        {
"username": "MPAdministrator",           "log_information":
         "id": "1",   {
                 "emailupdated_date": "mp@ministrator.com"2014-09-09T17:19:43",
                }"created_by_unit":
            },    {
        "entity": "BILL",             "lifecommunity_cycle_statename": "POSTEDMain Community",
             "number": "12",      "group_name": "Main Group",
    "exceptional_items":             [   "name": "Admin Unit",
       ],             "id": "34DBE1B8FAF5656003C4533F0D28392148305F8849E3C18B227C5BE3A27BA6DF",
            "criteria": "ee",             "alternative_code"description": "st1r1",
        },         {       "alternative_code": "MG"
     "log_information":           },
 {                 "updatedcreated_date": "2014-09-09T1708T11:1911:4332",
                "createdupdated_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",
                "updatedcreated_by_unituser":
                {
                    "communityperson_name": "Main CommunityMPAdministrator",
                    "group_nameusername": "Main GroupMPAdministrator",
                    "nameid": "Admin Unit1",
                    "idemail": "48305F8849E3C18B227C5BE3A27BA6DF",mp@ministrator.com"
                },
                "descriptionupdated_by_user": "r1",
                {
        "alternative_code": "MG"           "person_name": "MPAdministrator",
    },                "username": "created_by_user":MPAdministrator",
                    {"id": "1",
                    "person_nameemail": "MPAdministratormp@ministrator.com",
                }
   "username": "MPAdministrator",        },
            "identity": "1BILL",
            "life_cycle_state": "DRAFT",
      "email": "mp@ministrator.com"     "number": "13",
          },  "exceptional_items":
              "updated_by_user":[
                {
                    "person_namebill":
  "MPAdministrator",                  {
  "username": "MPAdministrator",                     "idtotal_amount_to_be_paid": "1",15,
                        "emailstatus": "mp@ministrator.comUNSETTLED",
                }             }"to_date": null,
            "entity": "BILL",
            "lifefrom_cycle_statedate": "DRAFT2013-05-27T00:00:00",
 
          "number": "13",             "exceptionallife_cycle_itemsstate": null,
             [           "total_billed_amount": 15,
    {                     "billnumber": "000023",
                   {     "id": "620123243FFB6EA791D29DFF07BE4A31"
                   "total_amount_to_be_paid": 15,
    },
                    "statusid": "UNSETTLEDE40C7E59C810845987F6CD08B04A72D1",
                },
       "to_date": null,        {
                "from_date": "2013-05-27T00:00:00",   "bill":
                     "life_cycle_state": null,{
                        "total_amount_to_billedbe_amountpaid": 150,
                        "numberstatus": "000023SETTLED",
                        "idto_date": "620123243FFB6EA791D29DFF07BE4A31"
      null,
             },                     "id"from_date": "E40C7E59C810845987F6CD08B04A72D1"2013-05-23T00:00:00",
                },             "life_cycle_state": null,
   {                     "billtotal_billed_amount": 0,
                   {         "number": "000001",
               "total_amount_to_be_paid": 0,        "id": "D2EA952648ACAFA425669AB83BB7355F"
               "status": "SETTLED",    },
                    "to_dateid": null,"8375EB155D136F1C658BB67AA0BBF358"
                }
           "from_date": "2013-05-23T00:00:00", ],
            "id": "C874E428073419A4D1195C747020F63F",
            "life_cycle_statecriteria": "random nullcriteria",
            "alternative_code": "test",
			"udf_float_1": null,
 	         "totaludf_billedfloat_amount2": 0null,
 	        "udf_float_3": null,
 	            "number"udf_float_4": "000001"null,
 	        "udf_string_1": null,
    	         "idudf_string_2": null,
"D2EA952648ACAFA425669AB83BB7355F" 	        "udf_string_3": null,
 	         }"udf_string_4": null,
	           "udf_string_5": null,
	         "idudf_string_6": "8375EB155D136F1C658BB67AA0BBF358"null,
	        "udf_string_7": null,
	      }  "udf_string_8": null,
	         ],
    "udf_date_1": null,
	        "idudf_date_2": "C874E428073419A4D1195C747020F63F"null,
    	        "criteriaudf_date_3": "random criteria"null,
   	         "alternativeudf_date_code4": "test"null	
        }
    ]
}

GET segmentation/preview

...

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

...

This method updates the exceptional items set. Single set of exceptional items can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Identifier

...

URL

Parameters

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

Anchor
segment_exceptional_item_update referred objects parameters
segment_exceptional_item_update referred objects parameters
Referred Parameter Objects Data

Include Page

	V4:segment_exceptional_items_update_parameters
	V4:segment_exceptional_items_update_parameters

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

...

complete
	V4:segmentation_

...

exceptional_items_set

(mandatory)

...

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

...

title	Example 1

HTTP Method: POST

Request:

...

complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
"token":"94062E7A48476DFFE4A60C208DEF6874",
"segmentation_identifier":{"number":"32"},
"exceptional_items_set":
        [
            {
                           "action": "add",
                           "entity_name":"BILLS",
                           "entity_value":"9F3458A149723312CB477AF94AA896DF"
            }
        ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
    "tokenstatus":"94062E7A48476DFFE4A60C208DEF6874",
"segmentation_identifier":{"number":"32"},
"exceptional_items_set":
    {
        "message": null,
        "description": null,
[        "code": "OK"
   { },
    "data":
    {
        "log_information":
       "action": "add", {
            "updated_date": "2014-11-03T15:50:53",
             "entitycreated_by_nameunit":"BILLS",
            {
                "entitycommunity_valuename": "9F3458A149723312CB477AF94AA896DFMain Community",
            }    "group_name": "Main Group",
  ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

         {     "statusname": "Admin Unit",
      {          "messageid": null"48305F8849E3C18B227C5BE3A27BA6DF",

       "description": null,         "codedescription": "OKr1",
    },     "data":     {  "alternative_code": "MG"
     "log_information":         {},
            "updatedcreated_date": "2014-1110-03T1510T17:5015:5319",
            "createdupdated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_codeid": "MG48305F8849E3C18B227C5BE3A27BA6DF"
 ,
          },             "created_date"description": "2014-10-10T17:15:19r1",
                "updatedalternative_by_unitcode": "MG"
           { },
               "community_name": "Main Community","created_by_user":
                "group_name": "Main Group",{
                "person_name": "Admin UnitMPAdministrator",
                "idusername": "48305F8849E3C18B227C5BE3A27BA6DFMPAdministrator",
                "descriptionid": "r11",
                "alternative_codeemail": "MGmp@ministrator.com"
            },
            "createdupdated_by_user":
            {
                "person_name": "MPAdministratorMarios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
       "mp@ministrator.com"
       }
        },
        "entity": "BILLS",
        "life_cycle_state": "DRAFT",
         },"number": "32",
        "exceptional_items":
         "updated_by_user":
[
            {
                "personentity_namevalue": "Marios Lannister9F3458A149723312CB477AF94AA896DF",
                "usernameentity_name": "MPAdministratorBILLS",
                "id": "1",E8DC1EC37CE91D23DE13B673B28D159C"
            }
        ],
        "emailid": null"FFF925224E7ACEDE0DA9C54AB5ECEF76",
        "criteria": "bill.number in ( "122","156")",
  }      "alternative_code": "RB",
 }		"udf_float_1": null,
        "entityudf_float_2": "BILLS"null,
        "lifeudf_cyclefloat_state3": "DRAFT"null,
        "numberudf_float_4": "32"null,
        "exceptionaludf_string_items1": null,
       [
  "udf_string_2": null,
          {
       "udf_string_3": null,
        "entityudf_string_value4": "9F3458A149723312CB477AF94AA896DF",
       null,
        "entityudf_string_name5": "BILLS"null,
        "udf_string_6": null,
        "idudf_string_7": "E8DC1EC37CE91D23DE13B673B28D159C"null,
        "udf_string_8": null,
  }         ]"udf_date_1": null,
        "idudf_date_2": "FFF925224E7ACEDE0DA9C54AB5ECEF76"null,
        "criteriaudf_date_3": "bill.number in ( "122","156")"null,
        "alternativeudf_date_code4": "RB"
    null
 }
}

Versions Compared

Old Version 31

New Version 32

Key

GET segmentation/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET segmentation/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET segmentation/preview

Resource URL

Parameters

URL

Parameters

Anchor
segment_exceptional_item_update referred objects parameters
segment_exceptional_item_update referred objects parameters
Referred Parameter Objects Data

Restrictions

Response Data

Restrictions

Response Data

Examples

Examples

Page Comparison

Versions Compared

Old Version 31

New Version 32

Key

GET segmentation/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET segmentation/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET segmentation/preview

Resource URL

Parameters

URL

Parameters

Anchorsegment_exceptional_item_update referred objects parameterssegment_exceptional_item_update referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Restrictions

Response Data

Examples

Examples

Anchor
segment_exceptional_item_update referred objects parameters
segment_exceptional_item_update referred objects parameters
Referred Parameter Objects Data