NetCard Server Web API

ReceiveInmateOrder

The following routes are available for this service:
POST	/Order/ReceiveInmateOrder

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/ReceiveInmateOrder HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/jsv
Content-Length: length

{
	Order: 
	{
		OrderId: 0,
		UserId: 0,
		DateOrdered: 0001-01-01,
		DeviceId: 0,
		DatePrinted: 0001-01-01,
		TotalAmount: 0,
		TransactionLogId: 0,
		IsReceived: False,
		User: 
		{
			UserId: 0,
			Username: String,
			Password: String,
			IsActive: False,
			LastUpdated: 0001-01-01,
			Title: String,
			FirstName: String,
			LastName: String,
			UserGenderId: 0,
			Phone: String,
			Email: String,
			MailAddress: String,
			MemberId: String,
			CustomerId: 0,
			UserAccessTypeId: 0,
			DateOfBirth: 0001-01-01,
			Mobile: String,
			StreetNumber: String,
			City: String,
			State: String,
			LocationId: 0,
			ChildLocationId: 0,
			UserAccount: 
			{
				UserId: 0,
				UserAccountTypeId: 0,
				AccountCode: String,
				AccountPin: String,
				AmountAvailable: 0,
				LastUpdated: 0001-01-01,
				IsActive: False,
				RewardPoints: 0,
				LunchMoney: 0,
				Block: String,
				SpendingLimit: 0,
				AmountAvailable2: 0,
				DischargeAmount: 0,
				LunchMoneyStatus: 0,
				AmountDeposited: 0,
				CardNumber: String,
				ProfileImagePath: String,
				IncidentalInStatus: 0,
				ActivationDate: 0001-01-01,
				Note: String,
				CollectedLunchMoneyDate: 0001-01-01,
				NumberOfShopsBuy: 0,
				PinLockOutTimeUtc: 0001-01-01,
				PalmId: String
			},
			Location: 
			{
				LocationId: 0,
				Name: String,
				Description: String,
				CustomerId: 0,
				ParentLocationId: 0
			},
			LastLogin: 0001-01-01,
			GroupId: 0,
			IsProntoDown: False
		},
		Device: 
		{
			DeviceId: 0,
			DeviceCode: String,
			Name: String,
			Password: String,
			DeviceLocationId: 0,
			ChildDeviceLocationId: 0,
			LastSeen: 0001-01-01,
			IsEnabled: False,
			Note: String,
			DeviceTypeId: 0,
			Cash: 0,
			DefaultTax: 0,
			LastVersion: String,
			CustomerId: 0,
			AssetId: String,
			DeviceLinkId: 0,
			OpenFrom: PT0S,
			OpenTo: PT0S,
			CashAccountCode: String,
			WarehouseId: 0
		}
	},
	OrderLines: 
	[
		{
			OrderLineId: 0,
			OrderId: 0,
			InventoryId: 0,
			Quantity: 0,
			TotalAmount: 0,
			AmountPerUnit: 0,
			QuantityReceived: 0,
			Order: 
			{
				OrderId: 0,
				UserId: 0,
				DateOrdered: 0001-01-01,
				DeviceId: 0,
				DatePrinted: 0001-01-01,
				TotalAmount: 0,
				TransactionLogId: 0,
				IsReceived: False,
				User: 
				{
					UserId: 0,
					Username: String,
					Password: String,
					IsActive: False,
					LastUpdated: 0001-01-01,
					Title: String,
					FirstName: String,
					LastName: String,
					UserGenderId: 0,
					Phone: String,
					Email: String,
					MailAddress: String,
					MemberId: String,
					CustomerId: 0,
					UserAccessTypeId: 0,
					DateOfBirth: 0001-01-01,
					Mobile: String,
					StreetNumber: String,
					City: String,
					State: String,
					LocationId: 0,
					ChildLocationId: 0,
					UserAccount: 
					{
						UserId: 0,
						UserAccountTypeId: 0,
						AccountCode: String,
						AccountPin: String,
						AmountAvailable: 0,
						LastUpdated: 0001-01-01,
						IsActive: False,
						RewardPoints: 0,
						LunchMoney: 0,
						Block: String,
						SpendingLimit: 0,
						AmountAvailable2: 0,
						DischargeAmount: 0,
						LunchMoneyStatus: 0,
						AmountDeposited: 0,
						CardNumber: String,
						ProfileImagePath: String,
						IncidentalInStatus: 0,
						ActivationDate: 0001-01-01,
						Note: String,
						CollectedLunchMoneyDate: 0001-01-01,
						NumberOfShopsBuy: 0,
						PinLockOutTimeUtc: 0001-01-01,
						PalmId: String
					},
					Location: 
					{
						LocationId: 0,
						Name: String,
						Description: String,
						CustomerId: 0,
						ParentLocationId: 0
					},
					LastLogin: 0001-01-01,
					GroupId: 0,
					IsProntoDown: False
				},
				Device: 
				{
					DeviceId: 0,
					DeviceCode: String,
					Name: String,
					Password: String,
					DeviceLocationId: 0,
					ChildDeviceLocationId: 0,
					LastSeen: 0001-01-01,
					IsEnabled: False,
					Note: String,
					DeviceTypeId: 0,
					Cash: 0,
					DefaultTax: 0,
					LastVersion: String,
					CustomerId: 0,
					AssetId: String,
					DeviceLinkId: 0,
					OpenFrom: PT0S,
					OpenTo: PT0S,
					CashAccountCode: String,
					WarehouseId: 0
				}
			},
			Inventory: 
			{
				InventoryId: 0,
				ProductId: 0,
				ProductTypeId: 0,
				ProductCategoryId: 0,
				Max: 0,
				ParLevel: 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,
				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,
					IsAdvertise: False,
					HealthFlag: 
					{
						HealthFlagId: 0,
						Name: String,
						Color: String
					}
				},
				Barcodes: 
				[
					String
				],
				Category: 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
			}
		]
	},
	IsSuccess: False,
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String
		}
	]
}