GET api/ClientSegments

Get a list of client segments available

Request Information

URI Parameters

None.

URI Example

api/ClientSegments

Body Parameters

None.

Response Information

Resource Description

A wrapper class with client segment information

Oresto.API.Models.GET.ClientSegments.ClientSegmentData

Name	Description	Type	Additional information
ClientSegments	A list of client segments	Collection of Oresto.API.Models.GET.ClientSegments.ClientSegment	None.
Errors	Possible errors that were experienced when processing the request	Collection of string	None.
RequestInformation	Additional information about the request	Oresto.API.Models.Shared.RequestInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientSegments": [
    {
      "Id": 1,
      "Localizations": [
        {
          "LanguageCode": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "LanguageCode": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Id": 1,
      "Localizations": [
        {
          "LanguageCode": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "LanguageCode": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    }
  ],
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ClientSegmentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.ClientSegments">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <RequestDuration>1</RequestDuration>
    <UserId>3</UserId>
    <WholesalerId>2</WholesalerId>
  </RequestInformation>
  <ClientSegments>
    <ClientSegment>
      <Id>1</Id>
      <Localizations>
        <ClientSegment.Localization>
          <Description>sample string 2</Description>
          <LanguageCode>sample string 1</LanguageCode>
        </ClientSegment.Localization>
        <ClientSegment.Localization>
          <Description>sample string 2</Description>
          <LanguageCode>sample string 1</LanguageCode>
        </ClientSegment.Localization>
      </Localizations>
    </ClientSegment>
    <ClientSegment>
      <Id>1</Id>
      <Localizations>
        <ClientSegment.Localization>
          <Description>sample string 2</Description>
          <LanguageCode>sample string 1</LanguageCode>
        </ClientSegment.Localization>
        <ClientSegment.Localization>
          <Description>sample string 2</Description>
          <LanguageCode>sample string 1</LanguageCode>
        </ClientSegment.Localization>
      </Localizations>
    </ClientSegment>
  </ClientSegments>
</ClientSegmentData>