(Quick Reference)
Service: List
Description: This web service return the list of customers segments in JSON format
URL:
https://BASE_URL/api/VERSION/customerSegmentations
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results | Integer | No | |
| max | limits the number of resources requested to return | Integer | No | |
| sort | Orders the results by the specified field | String | No | |
| order | Orders ascending (ASC) or descending (DESC) | Integer | No | asc,desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| reference | Wildcard search by the resource's reference | String | no | reference=Ref-6* , reference=*ef-6 , reference=*ef-6* |
| name | Wildcard search by the resource's name | String | no | |
Success Output
Success case: response.status=200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"name": "Segmentation1",
"reference": "ref-55",
"organization": "Lyon",
"description": "",
"dateCreated": "2016-05-10T16:05:41Z",
"lastUpdated": "2016-05-10T16:05:41Z"
},
{
"id": 2,
"name": "Segmentation2",
"reference": "Ref-88",
"organization": "Lyon",
"description": "",
"dateCreated": "2016-05-10T16:05:58Z",
"lastUpdated": "2016-05-10T16:05:58Z"
},
{
"id": 3,
"name": "Segmentation3",
"reference": "Ref-546",
"organization": "Lyon",
"description": "",
"dateCreated": "2016-05-10T16:06:17Z",
"lastUpdated": "2016-05-10T16:06:17Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
