(Quick Reference) Service: Show

Description: This web service return a customer segment details of the specified id in JSON format

URL:

https://BASE_URL/api/VERSION/customerSegmentations/{id}

URL with external_id:

https://BASE_URL/api/VERSION/customerSegmentations/reference/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idid of the wanted customer segmentLongYes777

Success Output

Success case: response.status=200
{
    "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_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The customer segmentation with the id 3999 doesn't exist."
}