POST {clientId}/DataExport/SegmentGroups

Add SegmentGroups.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

Segment Group class instance containing list of segments to import

SegmentGroupResult

Name	Description	Type	Additional information
SegmentGroups		Collection of SegmentGroup	None.

Request Formats

application/json, text/json

Sample:

{
  "SegmentGroups": [
    {
      "SearchLink": 1,
      "ClientLink": 2,
      "FolderLink": 3,
      "Name": "sample string 4",
      "Description": "sample string 5",
      "StatusNbr": 6,
      "ChannelNbr": 7,
      "Folders": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2"
        }
      ],
      "SegmentLines": [
        {
          "SearchGroupLink": 1,
          "SetOperatorNbr": 2,
          "GroupNumber": 3,
          "Position": 4,
          "SegmentReference": [
            {
              "Name": "sample string 1",
              "Description": "sample string 2"
            }
          ]
        }
      ],
      "SearchOutputFieldSets": [
        {
          "SearchOutputFieldSetLink": 1,
          "SearchOutputFormatNbr": 2,
          "SearchOutputFields": [
            {
              "SearchOutputFieldLink": 1,
              "SearchOutputFieldSetLink": 2,
              "DisplayFieldName": "sample string 3",
              "ActualColumnName": "sample string 4",
              "Description": "sample string 5",
              "DefaultOrderNumber": 6,
              "SearchOutputFieldTypeNbr": 7,
              "Indent": 8,
              "ParentLink": 1,
              "GrandParentLink": 1,
              "GreatGrandParentLink": 1,
              "GreatGreatGrandParentLink": 1,
              "IsAttributeColumn": true,
              "IsFilterHeaderColumn": true,
              "IsProgramColumn": true,
              "IsFilterHeaderPropertyColumn": true,
              "IsProgramPropertyColumn": true,
              "ElementLink": 14,
              "PropertyLink": 15
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SegmentGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <SegmentGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:SegmentGroup>
      <d2p1:ChannelNbr>7</d2p1:ChannelNbr>
      <d2p1:ClientLink>2</d2p1:ClientLink>
      <d2p1:Description>sample string 5</d2p1:Description>
      <d2p1:FolderLink>3</d2p1:FolderLink>
      <d2p1:Folders>
        <d2p1:Folders>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Folders>
      </d2p1:Folders>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:SearchLink>1</d2p1:SearchLink>
      <d2p1:SearchOutputFieldSets>
        <d2p1:SearchOutputFieldSets>
          <d2p1:SearchOutputFieldSetLink>1</d2p1:SearchOutputFieldSetLink>
          <d2p1:SearchOutputFields>
            <d2p1:SearchOutputFields>
              <d2p1:ActualColumnName>sample string 4</d2p1:ActualColumnName>
              <d2p1:DefaultOrderNumber>6</d2p1:DefaultOrderNumber>
              <d2p1:Description>sample string 5</d2p1:Description>
              <d2p1:DisplayFieldName>sample string 3</d2p1:DisplayFieldName>
              <d2p1:ElementLink>14</d2p1:ElementLink>
              <d2p1:GrandParentLink>1</d2p1:GrandParentLink>
              <d2p1:GreatGrandParentLink>1</d2p1:GreatGrandParentLink>
              <d2p1:GreatGreatGrandParentLink>1</d2p1:GreatGreatGrandParentLink>
              <d2p1:Indent>8</d2p1:Indent>
              <d2p1:IsAttributeColumn>true</d2p1:IsAttributeColumn>
              <d2p1:IsFilterHeaderColumn>true</d2p1:IsFilterHeaderColumn>
              <d2p1:IsFilterHeaderPropertyColumn>true</d2p1:IsFilterHeaderPropertyColumn>
              <d2p1:IsProgramColumn>true</d2p1:IsProgramColumn>
              <d2p1:IsProgramPropertyColumn>true</d2p1:IsProgramPropertyColumn>
              <d2p1:ParentLink>1</d2p1:ParentLink>
              <d2p1:PropertyLink>15</d2p1:PropertyLink>
              <d2p1:SearchOutputFieldLink>1</d2p1:SearchOutputFieldLink>
              <d2p1:SearchOutputFieldSetLink>2</d2p1:SearchOutputFieldSetLink>
              <d2p1:SearchOutputFieldTypeNbr>7</d2p1:SearchOutputFieldTypeNbr>
            </d2p1:SearchOutputFields>
          </d2p1:SearchOutputFields>
          <d2p1:SearchOutputFormatNbr>2</d2p1:SearchOutputFormatNbr>
        </d2p1:SearchOutputFieldSets>
      </d2p1:SearchOutputFieldSets>
      <d2p1:SegmentLines>
        <d2p1:SegmentLines>
          <d2p1:GroupNumber>3</d2p1:GroupNumber>
          <d2p1:Position>4</d2p1:Position>
          <d2p1:SearchGroupLink>1</d2p1:SearchGroupLink>
          <d2p1:SegmentReference>
            <d2p1:SegmentReference>
              <d2p1:Description>sample string 2</d2p1:Description>
              <d2p1:Name>sample string 1</d2p1:Name>
            </d2p1:SegmentReference>
          </d2p1:SegmentReference>
          <d2p1:SetOperatorNbr>2</d2p1:SetOperatorNbr>
        </d2p1:SegmentLines>
      </d2p1:SegmentLines>
      <d2p1:StatusNbr>6</d2p1:StatusNbr>
    </d2p1:SegmentGroup>
  </SegmentGroups>
</SegmentGroupResult>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)
BadRequest (400)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.