POST api/Segment/GetSegments

Request Information

URI Parameters

None.

Body Parameters

SegmentListRequestModel
NameDescriptionTypeAdditional 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": "8971ce76-d71f-48d6-bbee-73f17a318b65",
  "DefaultSelectedSegmentIds": [
    "0e4e1ade-e531-4013-b1b6-0b2d0cf3a928",
    "ab79d0e6-887c-4d89-828e-79a7f7770ca0"
  ]
}

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>0e4e1ade-e531-4013-b1b6-0b2d0cf3a928</d2p1:guid>
    <d2p1:guid>ab79d0e6-887c-4d89-828e-79a7f7770ca0</d2p1:guid>
  </DefaultSelectedSegmentIds>
  <MemberId>sample string 1</MemberId>
  <SegmentCategoryId>8971ce76-d71f-48d6-bbee-73f17a318b65</SegmentCategoryId>
</SegmentListRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SegmentListRequestModel'.

Response Information

Resource Description

SegmentListResponseModel
NameDescriptionTypeAdditional 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": "a32f8c64-3bc7-42f7-8b9f-610ada14ffbc",
  "SegmentsCount": 2,
  "SegmentsSelectedCount": 3,
  "Segments": [
    {
      "Id": "58096b49-9278-404a-8980-a2db2aa07747",
      "Name": "sample string 2",
      "IsSelected": true
    },
    {
      "Id": "58096b49-9278-404a-8980-a2db2aa07747",
      "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>a32f8c64-3bc7-42f7-8b9f-610ada14ffbc</SegmentCategoryId>
  <Segments>
    <SegmentListResponseModel.SegmentDetail>
      <Id>58096b49-9278-404a-8980-a2db2aa07747</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 2</Name>
    </SegmentListResponseModel.SegmentDetail>
    <SegmentListResponseModel.SegmentDetail>
      <Id>58096b49-9278-404a-8980-a2db2aa07747</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 2</Name>
    </SegmentListResponseModel.SegmentDetail>
  </Segments>
  <SegmentsCount>2</SegmentsCount>
  <SegmentsSelectedCount>3</SegmentsSelectedCount>
</SegmentListResponseModel>