GET api/ClientLocations

Get a list of client locations available

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientNumber

The number of the client defined by the wholesaler

string

Max length: 50

URI Example

api/ClientLocations?ClientNumber={ClientNumber}

Body Parameters

None.

Response Information

Resource Description

A wrapper class with client Location information

Oresto.API.Models.GET.ClientLocations.ClientLocationData
NameDescriptionTypeAdditional information
ClientLocations

A list of client locations

Collection of Oresto.API.Models.GET.ClientLocations.ClientLocation

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:
{
  "ClientLocations": [
    {
      "Id": 1,
      "ClientNumber": "sample string 2",
      "Remark": "sample string 3",
      "StreetName": "sample string 4",
      "ExtraAddressLine": "sample string 5",
      "StreetNumber": "sample string 6",
      "PostalCode": "sample string 7",
      "Company": "sample string 8",
      "Province": "sample string 9",
      "Municipality": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CountryCode": "sample string 12",
      "CountryLocalizations": [
        {
          "LanguageCode": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "LanguageCode": "sample string 1",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": 1,
      "ClientNumber": "sample string 2",
      "Remark": "sample string 3",
      "StreetName": "sample string 4",
      "ExtraAddressLine": "sample string 5",
      "StreetNumber": "sample string 6",
      "PostalCode": "sample string 7",
      "Company": "sample string 8",
      "Province": "sample string 9",
      "Municipality": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CountryCode": "sample string 12",
      "CountryLocalizations": [
        {
          "LanguageCode": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "LanguageCode": "sample string 1",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ClientLocationData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.ClientLocations">
  <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>
  <ClientLocations>
    <ClientLocation>
      <ClientNumber>sample string 2</ClientNumber>
      <Company>sample string 8</Company>
      <CountryCode>sample string 12</CountryCode>
      <CountryLocalizations>
        <CountryLocalization>
          <LanguageCode>sample string 1</LanguageCode>
          <Name>sample string 2</Name>
        </CountryLocalization>
        <CountryLocalization>
          <LanguageCode>sample string 1</LanguageCode>
          <Name>sample string 2</Name>
        </CountryLocalization>
      </CountryLocalizations>
      <ExtraAddressLine>sample string 5</ExtraAddressLine>
      <Id>1</Id>
      <Municipality>sample string 10</Municipality>
      <PhoneNumber>sample string 11</PhoneNumber>
      <PostalCode>sample string 7</PostalCode>
      <Province>sample string 9</Province>
      <Remark>sample string 3</Remark>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 6</StreetNumber>
    </ClientLocation>
    <ClientLocation>
      <ClientNumber>sample string 2</ClientNumber>
      <Company>sample string 8</Company>
      <CountryCode>sample string 12</CountryCode>
      <CountryLocalizations>
        <CountryLocalization>
          <LanguageCode>sample string 1</LanguageCode>
          <Name>sample string 2</Name>
        </CountryLocalization>
        <CountryLocalization>
          <LanguageCode>sample string 1</LanguageCode>
          <Name>sample string 2</Name>
        </CountryLocalization>
      </CountryLocalizations>
      <ExtraAddressLine>sample string 5</ExtraAddressLine>
      <Id>1</Id>
      <Municipality>sample string 10</Municipality>
      <PhoneNumber>sample string 11</PhoneNumber>
      <PostalCode>sample string 7</PostalCode>
      <Province>sample string 9</Province>
      <Remark>sample string 3</Remark>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 6</StreetNumber>
    </ClientLocation>
  </ClientLocations>
</ClientLocationData>