GET api/Clients

Gets a list of available clients

Request Information

URI Parameters

None.

URI Example

api/Clients

Body Parameters

None.

Response Information

Resource Description

A wrapper class with the clients

Oresto.API.Models.GET.Clients.ClientData

Name	Description	Type	Additional information
Clients	A list of clients	Collection of Oresto.API.Models.GET.Clients.Client	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:

{
  "Clients": [
    null,
    {
      "ClientNumber": "sample string 1",
      "Name": "sample string 2",
      "Email": "sample string 3",
      "MayViewPromoLabels": true,
      "PhoneNumber": "sample string 5",
      "Remarks": "sample string 6",
      "HasPromos": true,
      "OrdersMayBeDeliveredToClient": true,
      "Active": true,
      "Segment": {
        "Id": 1,
        "Localizations": [
          {
            "LanguageCode": "sample string 1",
            "Description": "sample string 2"
          },
          {
            "LanguageCode": "sample string 1",
            "Description": "sample string 2"
          }
        ]
      },
      "Representative": null,
      "Location": null
    }
  ],
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ClientData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.Clients">
  <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>
  <Clients>
    <Client i:nil="true" />
    <Client>
      <Active>true</Active>
      <ClientNumber>sample string 1</ClientNumber>
      <Email>sample string 3</Email>
      <HasPromos>true</HasPromos>
      <Location i:nil="true" />
      <MayViewPromoLabels>true</MayViewPromoLabels>
      <Name>sample string 2</Name>
      <OrdersMayBeDeliveredToClient>true</OrdersMayBeDeliveredToClient>
      <PhoneNumber>sample string 5</PhoneNumber>
      <Remarks>sample string 6</Remarks>
      <Representative xmlns:d4p1="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.Users" i:nil="true" />
      <Segment>
        <Id>1</Id>
        <Localizations>
          <Segment.Localization>
            <Description>sample string 2</Description>
            <LanguageCode>sample string 1</LanguageCode>
          </Segment.Localization>
          <Segment.Localization>
            <Description>sample string 2</Description>
            <LanguageCode>sample string 1</LanguageCode>
          </Segment.Localization>
        </Localizations>
      </Segment>
    </Client>
  </Clients>
</ClientData>