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 |
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 |
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 |
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
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
Examples
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
}
]
}