Redis Web Services

<back to all web services

GetNorthwindData

GetNorthwindDataResponse Parameters:
NameParameterData TypeRequiredDescription
CategoriesformList<CategoryDto>No
CustomersformList<CustomerDto>No
EmployeesformList<EmployeeDto>No
ShippersformList<ShipperDto>No
SuppliersformList<SupplierDto>No
OrdersformList<OrderDto>No
ProductsformList<ProductDto>No
OrderDetailsformList<OrderDetailDto>No
RegionsformList<RegionDto>No
TerritoriesformList<TerritoryDto>No
EmployeeTerritoriesformList<EmployeeTerritoryDto>No
ResponseStatusformResponseStatusNo
CategoryDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CategoryNameformstringNo
DescriptionformstringNo
CustomerDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CompanyNameformstringNo
ContactNameformstringNo
ContactTitleformstringNo
AddressformstringNo
CityformstringNo
RegionformstringNo
PostalCodeformstringNo
CountryformstringNo
PhoneformstringNo
FaxformstringNo
EmployeeDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LastNameformstringNo
FirstNameformstringNo
TitleformstringNo
TitleOfCourtesyformstringNo
BirthDateformDateTime?No
HireDateformDateTime?No
AddressformstringNo
CityformstringNo
RegionformstringNo
PostalCodeformstringNo
CountryformstringNo
HomePhoneformstringNo
ExtensionformstringNo
NotesformstringNo
ReportsToformint?No
PhotoPathformstringNo
ShipperDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyNameformstringNo
PhoneformstringNo
SupplierDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyNameformstringNo
ContactNameformstringNo
ContactTitleformstringNo
AddressformstringNo
CityformstringNo
RegionformstringNo
PostalCodeformstringNo
CountryformstringNo
PhoneformstringNo
FaxformstringNo
HomePageformstringNo
OrderDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformstringNo
EmployeeIdformintNo
OrderDateformDateTime?No
RequiredDateformDateTime?No
ShippedDateformDateTime?No
ShipViaformint?No
FreightformdecimalNo
ShipNameformstringNo
ShipAddressformstringNo
ShipCityformstringNo
ShipRegionformstringNo
ShipPostalCodeformstringNo
ShipCountryformstringNo
ProductDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ProductNameformstringNo
SupplierIdformintNo
CategoryIdformintNo
QuantityPerUnitformstringNo
UnitPriceformdecimalNo
UnitsInStockformshortNo
UnitsOnOrderformshortNo
ReorderLevelformshortNo
DiscontinuedformboolNo
OrderDetailDto Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
ProductIdformintNo
UnitPriceformdecimalNo
QuantityformshortNo
DiscountformdoubleNo
RegionDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
RegionDescriptionformstringNo
TerritoryDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TerritoryDescriptionformstringNo
RegionIdformintNo
EmployeeTerritoryDto Parameters:
NameParameterData TypeRequiredDescription
EmployeeIdformintNo
TerritoryIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetNorthwindData HTTP/1.1 
Host: redisadminui.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetNorthwindData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNorthwindDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:CategoryDto>
      <d2p1:CategoryName>String</d2p1:CategoryName>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
    </d2p1:CategoryDto>
  </Categories>
  <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:CustomerDto>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ContactName>String</d2p1:ContactName>
      <d2p1:ContactTitle>String</d2p1:ContactTitle>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:CustomerDto>
  </Customers>
  <EmployeeTerritories xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:EmployeeTerritoryDto>
      <d2p1:EmployeeId>0</d2p1:EmployeeId>
      <d2p1:TerritoryId>String</d2p1:TerritoryId>
    </d2p1:EmployeeTerritoryDto>
  </EmployeeTerritories>
  <Employees xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:EmployeeDto>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:City>String</d2p1:City>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Extension>String</d2p1:Extension>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:HireDate>0001-01-01T00:00:00</d2p1:HireDate>
      <d2p1:HomePhone>String</d2p1:HomePhone>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PhotoPath>String</d2p1:PhotoPath>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:ReportsTo>0</d2p1:ReportsTo>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:TitleOfCourtesy>String</d2p1:TitleOfCourtesy>
    </d2p1:EmployeeDto>
  </Employees>
  <OrderDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:OrderDetailDto>
      <d2p1:Discount>0</d2p1:Discount>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
    </d2p1:OrderDetailDto>
  </OrderDetails>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:OrderDto>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:EmployeeId>0</d2p1:EmployeeId>
      <d2p1:Freight>0</d2p1:Freight>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
      <d2p1:RequiredDate>0001-01-01T00:00:00</d2p1:RequiredDate>
      <d2p1:ShipAddress>String</d2p1:ShipAddress>
      <d2p1:ShipCity>String</d2p1:ShipCity>
      <d2p1:ShipCountry>String</d2p1:ShipCountry>
      <d2p1:ShipName>String</d2p1:ShipName>
      <d2p1:ShipPostalCode>String</d2p1:ShipPostalCode>
      <d2p1:ShipRegion>String</d2p1:ShipRegion>
      <d2p1:ShipVia>0</d2p1:ShipVia>
      <d2p1:ShippedDate>0001-01-01T00:00:00</d2p1:ShippedDate>
    </d2p1:OrderDto>
  </Orders>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:ProductDto>
      <d2p1:CategoryId>0</d2p1:CategoryId>
      <d2p1:Discontinued>false</d2p1:Discontinued>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ProductName>String</d2p1:ProductName>
      <d2p1:QuantityPerUnit>String</d2p1:QuantityPerUnit>
      <d2p1:ReorderLevel>0</d2p1:ReorderLevel>
      <d2p1:SupplierId>0</d2p1:SupplierId>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
      <d2p1:UnitsInStock>0</d2p1:UnitsInStock>
      <d2p1:UnitsOnOrder>0</d2p1:UnitsOnOrder>
    </d2p1:ProductDto>
  </Products>
  <Regions xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:RegionDto>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:RegionDescription>String</d2p1:RegionDescription>
    </d2p1:RegionDto>
  </Regions>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <Shippers xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:ShipperDto>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Phone>String</d2p1:Phone>
    </d2p1:ShipperDto>
  </Shippers>
  <Suppliers xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:SupplierDto>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ContactName>String</d2p1:ContactName>
      <d2p1:ContactTitle>String</d2p1:ContactTitle>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:HomePage>String</d2p1:HomePage>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:SupplierDto>
  </Suppliers>
  <Territories xmlns:d2p1="http://schemas.datacontract.org/2004/07/RedisAdminUI.DataSource.Northwind">
    <d2p1:TerritoryDto>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:RegionId>0</d2p1:RegionId>
      <d2p1:TerritoryDescription>String</d2p1:TerritoryDescription>
    </d2p1:TerritoryDto>
  </Territories>
</GetNorthwindDataResponse>