Northwind Web Services

<back to all web services

CustomerDetails

The following routes are available for this service:
All Verbs/customers/{Id}
CustomerDetails Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
CustomerDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerformCustomerNo
CustomerOrdersformList<CustomerOrder>No
ResponseStatusformResponseStatusNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CompanyNameformstringNo
ContactNameformstringNo
ContactTitleformstringNo
AddressformstringNo
CityformstringNo
RegionformstringNo
PostalCodeformstringNo
CountryformstringNo
PhoneformstringNo
FaxformstringNo
CustomerOrder Parameters:
NameParameterData TypeRequiredDescription
OrderformOrderNo
OrderDetailsformList<OrderDetail>No
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformstringNo
EmployeeIdformintNo
OrderDateformDateTime?No
RequiredDateformDateTime?No
ShippedDateformDateTime?No
ShipViaformint?No
FreightformdecimalNo
ShipNameformstringNo
ShipAddressformstringNo
ShipCityformstringNo
ShipRegionformstringNo
ShipPostalCodeformstringNo
ShipCountryformstringNo
OrderDetail Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
ProductIdformintNo
UnitPriceformdecimalNo
QuantityformshortNo
DiscountformdoubleNo

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 /customers/{Id} HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	customer: 
	{
		id: String,
		companyName: String,
		contactName: String,
		contactTitle: String,
		address: String,
		city: String,
		region: String,
		postalCode: String,
		country: String,
		phone: String,
		fax: String
	},
	customerOrders: 
	[
		{
			order: 
			{
				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
			},
			orderDetails: 
			[
				{
					orderId: 0,
					productId: 0,
					unitPrice: 0,
					quantity: 0,
					discount: 0
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}