POST api/Segment/GetSegments
Request Information
URI Parameters
None.
Body Parameters
SegmentListRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberId | string |
None. |
|
| OrgId | globally unique identifier |
None. |
|
| SegmentCategoryId | globally unique identifier |
None. |
|
| DefaultSelectedSegmentIds | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"MemberId": "sample string 1",
"OrgId": "c6971f46-682d-4c1f-ba9e-07b3a7d261f5",
"SegmentCategoryId": "331735ad-e325-4c7e-bd16-c1f30586bdc7",
"DefaultSelectedSegmentIds": [
"6e12a992-791d-4101-964a-862ca5192a0c",
"3eab9792-951c-4451-9f0a-6b0af3659cc5"
]
}
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>6e12a992-791d-4101-964a-862ca5192a0c</d2p1:guid>
<d2p1:guid>3eab9792-951c-4451-9f0a-6b0af3659cc5</d2p1:guid>
</DefaultSelectedSegmentIds>
<MemberId>sample string 1</MemberId>
<OrgId>c6971f46-682d-4c1f-ba9e-07b3a7d261f5</OrgId>
<SegmentCategoryId>331735ad-e325-4c7e-bd16-c1f30586bdc7</SegmentCategoryId>
</SegmentListRequestModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
SegmentListResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberId | string |
None. |
|
| OrgId | globally unique identifier |
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",
"OrgId": "b1c7ebbb-336f-4a2e-85e9-87886b3dff66",
"SegmentCategoryId": "86b8c9a7-b105-4442-85c1-492dd11af1e8",
"SegmentsCount": 2,
"SegmentsSelectedCount": 3,
"Segments": [
{
"Id": "1b1b8ea5-5ffc-4c4d-92e4-a8feff0033b4",
"Name": "sample string 2",
"IsSelected": true
},
{
"Id": "1b1b8ea5-5ffc-4c4d-92e4-a8feff0033b4",
"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>
<OrgId>b1c7ebbb-336f-4a2e-85e9-87886b3dff66</OrgId>
<SegmentCategoryId>86b8c9a7-b105-4442-85c1-492dd11af1e8</SegmentCategoryId>
<Segments>
<SegmentListResponseModel.SegmentDetail>
<Id>1b1b8ea5-5ffc-4c4d-92e4-a8feff0033b4</Id>
<IsSelected>true</IsSelected>
<Name>sample string 2</Name>
</SegmentListResponseModel.SegmentDetail>
<SegmentListResponseModel.SegmentDetail>
<Id>1b1b8ea5-5ffc-4c4d-92e4-a8feff0033b4</Id>
<IsSelected>true</IsSelected>
<Name>sample string 2</Name>
</SegmentListResponseModel.SegmentDetail>
</Segments>
<SegmentsCount>2</SegmentsCount>
<SegmentsSelectedCount>3</SegmentsSelectedCount>
</SegmentListResponseModel>