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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Categories: 
	[
		{
			Id: 0,
			CategoryName: String,
			Description: String
		}
	],
	Customers: 
	[
		{
			Id: String,
			CompanyName: String,
			ContactName: String,
			ContactTitle: String,
			Address: String,
			City: String,
			Region: String,
			PostalCode: String,
			Country: String,
			Phone: String,
			Fax: String
		}
	],
	Employees: 
	[
		{
			Id: 0,
			LastName: String,
			FirstName: String,
			Title: String,
			TitleOfCourtesy: String,
			BirthDate: 0001-01-01,
			HireDate: 0001-01-01,
			Address: String,
			City: String,
			Region: String,
			PostalCode: String,
			Country: String,
			HomePhone: String,
			Extension: String,
			Notes: String,
			ReportsTo: 0,
			PhotoPath: String
		}
	],
	Shippers: 
	[
		{
			Id: 0,
			CompanyName: String,
			Phone: String
		}
	],
	Suppliers: 
	[
		{
			Id: 0,
			CompanyName: String,
			ContactName: String,
			ContactTitle: String,
			Address: String,
			City: String,
			Region: String,
			PostalCode: String,
			Country: String,
			Phone: String,
			Fax: String,
			HomePage: String
		}
	],
	Orders: 
	[
		{
			Id: 0,
			CustomerId: String,
			EmployeeId: 0,
			OrderDate: 0001-01-01,
			RequiredDate: 0001-01-01,
			ShippedDate: 0001-01-01,
			ShipVia: 0,
			Freight: 0,
			ShipName: String,
			ShipAddress: String,
			ShipCity: String,
			ShipRegion: String,
			ShipPostalCode: String,
			ShipCountry: String
		}
	],
	Products: 
	[
		{
			Id: 0,
			ProductName: String,
			SupplierId: 0,
			CategoryId: 0,
			QuantityPerUnit: String,
			UnitPrice: 0,
			UnitsInStock: 0,
			UnitsOnOrder: 0,
			ReorderLevel: 0,
			Discontinued: False
		}
	],
	OrderDetails: 
	[
		{
			OrderId: 0,
			ProductId: 0,
			UnitPrice: 0,
			Quantity: 0,
			Discount: 0
		}
	],
	Regions: 
	[
		{
			Id: 0,
			RegionDescription: String
		}
	],
	Territories: 
	[
		{
			Id: String,
			TerritoryDescription: String,
			RegionId: 0
		}
	],
	EmployeeTerritories: 
	[
		{
			EmployeeId: 0,
			TerritoryId: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}