POST api/Segment/GetSegments

Request Information

URI Parameters

None.

Body Parameters

Name	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": "91581483-639b-4300-9cb1-74020e3357d6",
  "SegmentCategoryId": "8e5b3ceb-d931-45cb-80ae-f30d0b578caf",
  "DefaultSelectedSegmentIds": [
    "577be6e8-ed1f-4819-ab4a-d71513242147",
    "e40635fc-5b34-4679-8e6b-1fffb64efa45"
  ]
}

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>577be6e8-ed1f-4819-ab4a-d71513242147</d2p1:guid>
    <d2p1:guid>e40635fc-5b34-4679-8e6b-1fffb64efa45</d2p1:guid>
  </DefaultSelectedSegmentIds>
  <MemberId>sample string 1</MemberId>
  <OrgId>91581483-639b-4300-9cb1-74020e3357d6</OrgId>
  <SegmentCategoryId>8e5b3ceb-d931-45cb-80ae-f30d0b578caf</SegmentCategoryId>
</SegmentListRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SegmentListResponseModel

Name	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": "1952c7a5-8612-4cd8-82c7-01b13b7b6f51",
  "SegmentCategoryId": "153b11d9-72c7-4468-bb29-b7cab9ab44cc",
  "SegmentsCount": 2,
  "SegmentsSelectedCount": 3,
  "Segments": [
    {
      "Id": "4eb4d91d-d8a7-4c3b-a457-903ed273296d",
      "Name": "sample string 2",
      "IsSelected": true
    },
    {
      "Id": "4eb4d91d-d8a7-4c3b-a457-903ed273296d",
      "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>1952c7a5-8612-4cd8-82c7-01b13b7b6f51</OrgId>
  <SegmentCategoryId>153b11d9-72c7-4468-bb29-b7cab9ab44cc</SegmentCategoryId>
  <Segments>
    <SegmentListResponseModel.SegmentDetail>
      <Id>4eb4d91d-d8a7-4c3b-a457-903ed273296d</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 2</Name>
    </SegmentListResponseModel.SegmentDetail>
    <SegmentListResponseModel.SegmentDetail>
      <Id>4eb4d91d-d8a7-4c3b-a457-903ed273296d</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 2</Name>
    </SegmentListResponseModel.SegmentDetail>
  </Segments>
  <SegmentsCount>2</SegmentsCount>
  <SegmentsSelectedCount>3</SegmentsSelectedCount>
</SegmentListResponseModel>