GET api/Suppliers

Retrieves the list of suppliers

Request Information

URI Parameters

None.

URI Example

api/Suppliers

Body Parameters

None.

Response Information

Resource Description

A wrapper class with the suppliers

Oresto.API.Models.GET.Suppliers.SupplierData
NameDescriptionTypeAdditional information
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.

Suppliers

A list of suppliers

Collection of Oresto.API.Models.GET.Suppliers.Supplier

None.

Response Formats

application/json, text/json

Sample:
{
  "Suppliers": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "VatCountryCode": "sample string 3",
      "VatNumber": "sample string 4",
      "Active": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "VatCountryCode": "sample string 3",
      "VatNumber": "sample string 4",
      "Active": true
    }
  ],
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SupplierData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.Suppliers">
  <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>
  <Suppliers>
    <Supplier>
      <Active>true</Active>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <VatCountryCode>sample string 3</VatCountryCode>
      <VatNumber>sample string 4</VatNumber>
    </Supplier>
    <Supplier>
      <Active>true</Active>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <VatCountryCode>sample string 3</VatCountryCode>
      <VatNumber>sample string 4</VatNumber>
    </Supplier>
  </Suppliers>
</SupplierData>