Available from CRM.COM R4.0.0

GET segmentation/show

This method returns information related with a segmentation. Single segmentation is returned by each call

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

Name

Type

Description

id

(semi-optional)

String

The ID of the segmentation

number

(semi-optional)

String

The number of the segmentation

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

Name	Type	Description
id	String	The ID of the retrieved segment
number	String	The number of the retrieved segment
alternative_code	String	The alternative code of the retrieved segment
life_cycle_state	String	The life cycle state of the retrieved segment which can be DRAFT or POSTED
criteria	String	The segmentation criteria of the retrieved segment
entity	String	The entity of the retrieved segment which can be one of the following ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES FINANCIALTRANSACTIONS INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
exceptional_items	Exceptional items object	The exceptional items of the retrieved segment
log_information	Log Information Object	The log information of the retrieved segment

Referred Objects Response Data

segmentation_exceptional_items object response data

Name	Type	Description
id	String	The id of the segmentation exceptional items
entity_name	String	The entity name of the retrieved segment which can be ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_value	String	The primary key value of the entity which is added as an exceptional item of the retrieved segment

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "number": "14",
        "udf_float_4": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "id": "A718F14BB72DD5B0951F5BB41ED09403",
        "criteria": "random criteria",
        "entity": "SUBSCRIPTION",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "log_information":
        {
            "updated_date": "2014-09-15T11:07:02",
            "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-09T18:24:05",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Marketing Unit",
                "id": "83922FE923563679768A94F58CAB5569",
                "description": "r1c1",
                "alternative_code": null
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "csrtest",
                "username": "csrtest",
                "id": "BFF291E518D0BFA061EC6ECCD386BCA1",
                "email": "csrtest@crm.com"
            }
        },
        "life_cycle_state": "POSTED",
        "exceptional_items":
        [
            {
                "entity_value": "4AB934541D55D9321473EBB4923515C1",
                "entity_name": "SUBSCRIPTIONS",
                "id": "54FF66E68D1312E0DDBEF5B25E5999CB"
            },
            {
                "entity_value": "8DD369DC4853C63C9BE19ADA4FC0A867",
                "entity_name": "SUBSCRIPTIONS",
                "id": "BC77F7D331D7AFB1435E0FBB46CD6107"
            },
            {
                "entity_value": "F8B3A0426CCE4FAC8D8118DFC18073D5",
                "entity_name": "SUBSCRIPTIONS",
                "id": "447254BAB06D0203EC9CE206331FFB92"
            },
            {
                "entity_value": "A60B45D48F24CE3C1099FEB5D4FCEC2E",
                "entity_name": "SUBSCRIPTIONS",
                "id": "0A17A1800EC7F6DA2C4878F354503BBE"
            }
        ],
        "description": null,
        "alternative_code": "sts"
    }
}

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, BUYINADVANCEREQUESTS
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

Name	Type	Description
id	String	The ID of the retrieved segment
number	String	The number of the retrieved segment
alternative_code	String	The alternative code of the retrieved segment
life_cycle_state	String	The life cycle state of the retrieved segment which can be DRAFT or POSTED
criteria	String	The segmentation criteria of the retrieved segment
entity	String	The entity of the retrieved segment which can be one of the following ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES FINANCIALTRANSACTIONS INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
exceptional_items	Exceptional items object	The exceptional items of the retrieved segment
log_information	Log Information Object	The log information of the retrieved segment

Referred Objects Response Data

segmentation_exceptional_items object response data

Name	Type	Description
id	String	The id of the segmentation exceptional items
entity_name	String	The entity name of the retrieved segment which can be ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_value	String	The primary key value of the entity which is added as an exceptional item of the retrieved segment

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2014-09-08T10:53:14",
                "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-08T10:41:25",
                "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"
                }
            },
            "entity": "BILL",
            "life_cycle_state": "POSTED",
            "number": "12",
            "exceptional_items":
            [
            ],
            "id": "34DBE1B8FAF5656003C4533F0D283921",
            "criteria": "ee",
            "alternative_code": "st1",
			"udf_float_1": null,
 	        "udf_float_2": null,
 	        "udf_float_3": null,
 	        "udf_float_4": null,
 	        "udf_string_1": null,
 	        "udf_string_2": null,
 	        "udf_string_3": null,
 	        "udf_string_4": null,
	        "udf_string_5": null,
	        "udf_string_6": null,
	        "udf_string_7": null,
	        "udf_string_8": null,
	        "udf_date_1": null,
	        "udf_date_2": null,
	        "udf_date_3": null,
	        "udf_date_4": null		
	 },
        {
            "log_information":
            {
                "updated_date": "2014-09-09T17:19:43",
                "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": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "entity": "BILL",
            "life_cycle_state": "DRAFT",
            "number": "13",
            "exceptional_items":
            [
                {
                    "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": 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"
                }
            ],
            "id": "C874E428073419A4D1195C747020F63F",
            "criteria": "random criteria",
            "alternative_code": "test",
			"udf_float_1": null,
 	        "udf_float_2": null,
 	        "udf_float_3": null,
 	        "udf_float_4": null,
 	        "udf_string_1": null,
 	        "udf_string_2": null,
 	        "udf_string_3": null,
 	        "udf_string_4": null,
	        "udf_string_5": null,
	        "udf_string_6": null,
	        "udf_string_7": null,
	        "udf_string_8": null,
	        "udf_date_1": null,
	        "udf_date_2": null,
	        "udf_date_3": null,
	        "udf_date_4": null	
        }
    ]
}

GET segmentation/preview

This method returns information which is included in the segment. Single segmentation is returned by each call

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

Name

Type

Description

id

(semi-optional)

String

The ID of the segmentation

number

(semi-optional)

String

The number of the segmentation

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

Name	Type	Description
entity_name	String	The name of the segmentation entity
entity_id	String	The id of the segmentation entity
entity_number	String	The number of the segmentation entity, if applicable
entity_alternative_code	String	The alternative code of the segmentation entity, if applicable
entity_description	String	The description of the segmentation entity, if applicable
accounts_receivable	Accounts Receivable Object	The Accounts Receivable of the segmented entity. Applicable only for Accounts Receivable-based entities and in cases in which the segment's entity is one of the following: BILLS BUYINADVANCEREQUESTS CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS PAYMENTS PAYMENTCANCELLATIONS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS REFUNDS REWARDAWARDTRANSACTIONS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WRITEOFFS SUBSCRIPTIONACTIONS Available from CRM.COM R12.0.0 SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, REFUNDS, PAYMENTCANCELLATIONS, WALLETS, WRITEOFFS are available from CRM.COM R15.0.0
contact_information	Contact Information Object	The Contact Information of the segmented entity. Applicable only for Contact Information-based entities and in cases in which the segment's entity is one of the following: ACTIVITIES LEADS Available from CRM.COM R12.0.0 LEADS is available from CRM.COM R15.0.0

Referred Objects Response Data

segment_accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable

segment_contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
name	String	The full name of the retrieved contact information

Examples

Example 1

HTTP Method: GET

Request:

Response:

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "entity_description": null,
            "entity_number": "J000409",
            "entity_name": null,
            "entity_id": "3349DB8598845E977E27775A01093E6E",
            "entity_alternative_code": null
        },
        {
            "entity_description": "test desc1",
            "entity_number": "13",
            "entity_name": null,
            "entity_id": "37B285CE1C9874D60B7F26B9E06EF95C",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "80",
            "entity_name": null,
            "entity_id": "52EA8108A003E206B901099CD38E13E3",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "82",
            "entity_name": null,
            "entity_id": "5E9F01ECC7A71E1295AD7896E183F5B2",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "83",
            "entity_name": null,
            "entity_id": "96A77117BF2B72D88929188E5A9D5657",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "84",
            "entity_name": null,
            "entity_id": "B699D60C9B58D2B3689A0AD8A5FEF5F6",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "81",
            "entity_name": null,
            "entity_id": "E42FE581568977DE4482202055E5E66F",
            "entity_alternative_code": null
        }
    ]
}

POST segmentation/exceptional_items/update

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

segmentation_identifier

(mandatory)

Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the segmentation

number

(semi-optional)

String

The number of the segmentation

exceptional_items_set

(mandatory)

Set of Segmentation Exceptional Item Objects

The segment exceptional item objects to be updated

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

Referred Parameter Objects Data

Segmentation exceptional items parameters object data

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

id

(mandatory and applicable only on remove)

String

The ID of the segmentation exceptional item to be updated

entity_name

(mandatory and applicable only on add)

String

The entity name of the retrieved segment which can be one of the following:

ACCOUNTSRECEIVABLE
ACTIVITIES
BILLS
BUYINADVANCEREQUESTS
CONTACTINFORMATION
CREDITNOTES
INVOICES
INVOICECANCELLATIONS
JOBS
LEADS
PAYMENTGATEWAYCARDS
PAYMENTGATEWAYREQUESTS
PAYMENTS
PAYMENTCANCELLATIONS
REFUNDS
REWARDAWARDTRANSACTIONS
REWARDOFFERS
REWARDPARTICIPANTS
REWARDSPENDTRANSACTIONS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS
WRITEOFFS
SUBSCRIPTIONACTIONS

SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0

CREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0

entity_value

(mandatory and applicable only on add)

String

The primary key value of the entity which is added as an exceptional item of the retrieved segment

Restrictions

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved segment
number	String	The number of the retrieved segment
alternative_code	String	The alternative code of the retrieved segment
life_cycle_state	String	The life cycle state of the retrieved segment which can be DRAFT or POSTED
criteria	String	The segmentation criteria of the retrieved segment
entity	String	The entity of the retrieved segment which can be one of the following ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES FINANCIALTRANSACTIONS INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
exceptional_items	Exceptional items object	The exceptional items of the retrieved segment
log_information	Log Information Object	The log information of the retrieved segment

Referred Objects Response Data

segmentation_exceptional_items object response data

Name	Type	Description
id	String	The id of the segmentation exceptional items
entity_name	String	The entity name of the retrieved segment which can be ACCOUNTSRECEIVABLE ACTIVITIES BILLS BUYINADVANCEREQUESTS CONTACTINFORMATION CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS LEADS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS PAYMENTS PAYMENTCANCELLATIONS REFUNDS REWARDAWARDTRANSACTIONS REWARDOFFERS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WALLETTRANSACTIONS WRITEOFFS SUBSCRIPTIONACTIONS SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_value	String	The primary key value of the entity which is added as an exceptional item of the retrieved segment

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: POST

Request:

Body:

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

Response:

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "log_information":
        {
            "updated_date": "2014-11-03T15:50:53",
            "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-10T17:15:19",
            "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": "BILLS",
        "life_cycle_state": "DRAFT",
        "number": "32",
        "exceptional_items":
        [
            {
                "entity_value": "9F3458A149723312CB477AF94AA896DF",
                "entity_name": "BILLS",
                "id": "E8DC1EC37CE91D23DE13B673B28D159C"
            }
        ],
        "id": "FFF925224E7ACEDE0DA9C54AB5ECEF76",
        "criteria": "bill.number in ( "122","156")",
        "alternative_code": "RB",
		"udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null
 }
}