NetCard Server Web API

<back to all web services

KMGetDeviceInventoryByCoil

The following routes are available for this service:
GET/DeviceInventory/KMGetDeviceInventoryByCoil

To override the Content-type in your clients 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/KMGetDeviceInventoryByCoil HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/jsv
Content-Length: length

{
	DeviceId: 0,
	Coil: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	DeviceInventory: 
	{
		DeviceId: 0,
		InventoryId: 0,
		Inventory: 
		{
			InventoryId: 0,
			ProductId: 0,
			ProductTypeId: 0,
			ProductCategoryId: 0,
			Max: 0,
			Low: 0,
			Quantity: 0,
			IsLow: False,
			CostBuyPrice: 0,
			RawPrice: 0,
			Tax: 0,
			TaxPercent: 0,
			Image: AA==,
			ImageVersion: 0,
			Note: String,
			LastChanged: 0001-01-01,
			PointsRewarded: 0,
			PointsCost: 0,
			CustomerId: 0,
			Description: String,
			SalePrice: 0,
			Taken: 0,
			Coil: String,
			IsAssigned: False,
			Product: 
			{
				ProductId: 0,
				SupplierId: 0,
				ManufacturerId: 0,
				Name: String,
				ShortDescription: String,
				StockCode: String,
				Note: String,
				Healthy: False,
				PicCode: String,
				Size: String,
				CustomerId: 0,
				UnitCost: 0,
				Cost: 0,
				RecommendedSalePrice: 0,
				PaidTax: 0,
				ProductImage: String,
				HealthFlagId: 0,
				StockRestriction: String,
				IsDeleted: False,
				LastUpdated: 0001-01-01,
				HealthFlag: 
				{
					HealthFlagId: 0,
					Name: String,
					Color: String,
					IsDeleted: False,
					LastUpdated: 0001-01-01
				}
			},
			Barcodes: 
			[
				String
			],
			Category: String,
			isDeleted: False,
			LastUpdated: 0001-01-01
		},
		IsDeleted: False,
		LastUpdated: 0001-01-01,
		AccountCode: String
	},
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String
		}
	]
}