POST api/Segment/GetSegments
Request Information
URI Parameters
None.
Body Parameters
SegmentListRequestModelName | Description | Type | Additional information |
---|---|---|---|
MemberId | string |
None. |
|
SegmentCategoryId | globally unique identifier |
None. |
|
DefaultSelectedSegmentIds | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "MemberId": "sample string 1", "SegmentCategoryId": "943d1713-9532-4ceb-b401-ecff7af4af66", "DefaultSelectedSegmentIds": [ "2cd062d3-0499-4338-a43e-eac39e51e38c", "5c54153b-a27a-4a39-be2c-6c8991899dca" ] }
application/xml, text/xml
Sample:
<SegmentListRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Request"> <DefaultSelectedSegmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>2cd062d3-0499-4338-a43e-eac39e51e38c</d2p1:guid> <d2p1:guid>5c54153b-a27a-4a39-be2c-6c8991899dca</d2p1:guid> </DefaultSelectedSegmentIds> <MemberId>sample string 1</MemberId> <SegmentCategoryId>943d1713-9532-4ceb-b401-ecff7af4af66</SegmentCategoryId> </SegmentListRequestModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
SegmentListResponseModelName | Description | Type | Additional information |
---|---|---|---|
MemberId | string |
None. |
|
SegmentCategoryId | globally unique identifier |
None. |
|
SegmentsCount | integer |
None. |
|
SegmentsSelectedCount | integer |
None. |
|
Segments | Collection of SegmentDetail |
None. |
|
Result | ResponseResult |
None. |
Response Formats
application/json, text/json
Sample:
{ "MemberId": "sample string 1", "SegmentCategoryId": "cdbf8356-3c06-457d-9c7a-47e54bf114bf", "SegmentsCount": 2, "SegmentsSelectedCount": 3, "Segments": [ { "Id": "6989c590-af88-4c53-a77f-ec991be6231f", "Name": "sample string 2", "IsSelected": true }, { "Id": "6989c590-af88-4c53-a77f-ec991be6231f", "Name": "sample string 2", "IsSelected": true } ], "Result": { "Success": true, "Message": "sample string 2", "Errors": [ { "Message": "sample string 1" }, { "Message": "sample string 1" } ] } }
application/xml, text/xml
Sample:
<SegmentListResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response"> <Result> <Errors> <ErrorMessage> <Message>sample string 1</Message> </ErrorMessage> <ErrorMessage> <Message>sample string 1</Message> </ErrorMessage> </Errors> <Message>sample string 2</Message> <Success>true</Success> </Result> <MemberId>sample string 1</MemberId> <SegmentCategoryId>cdbf8356-3c06-457d-9c7a-47e54bf114bf</SegmentCategoryId> <Segments> <SegmentListResponseModel.SegmentDetail> <Id>6989c590-af88-4c53-a77f-ec991be6231f</Id> <IsSelected>true</IsSelected> <Name>sample string 2</Name> </SegmentListResponseModel.SegmentDetail> <SegmentListResponseModel.SegmentDetail> <Id>6989c590-af88-4c53-a77f-ec991be6231f</Id> <IsSelected>true</IsSelected> <Name>sample string 2</Name> </SegmentListResponseModel.SegmentDetail> </Segments> <SegmentsCount>2</SegmentsCount> <SegmentsSelectedCount>3</SegmentsSelectedCount> </SegmentListResponseModel>