Mds.Api

<back to all web services

DiagramSingle

Requires Authentication
Requires any of the roles:dealer-api-mds, dealer-api-nop
The following routes are available for this service:
All Verbs/diagram-single/{DiagramId}
DiagramSingle Parameters:
NameParameterData TypeRequiredDescription
DiagramIdpathintNo
DiagramSingleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PartsformList<MyobStockItemMapping>No
MyobStockItemMapping Parameters:
NameParameterData TypeRequiredDescription
StockItemIdformintNo
IdformintNo
NumberformintNo
InventoryIdformstringNo
GroupIdformintNo
NameformstringNo
RetailPriceformdecimal?No
DealerPriceformdecimal?No
TradePriceformdecimal?No
RetailPriceNzformdecimal?No
TradePriceNzformdecimal?No
DealerPriceNzformdecimal?No
SalesUomformstringNo
StockingIndicatorformstringNo
ColorformstringNo
ColorCodeformstringNo
NoteTextformstringNo
CoordinatesformList<Coordinate>No
PartQuantityformintNo
AvaiableQuantityformintNo
ShowAvailabilityPopUpformboolNo
IsFdformboolNo
Coordinate Parameters:
NameParameterData TypeRequiredDescription
x1formintNo
y1formintNo
x2formintNo
y2formintNo

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 /diagram-single/{DiagramId} HTTP/1.1 
Host: mds-api.mojomotorcycles.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DiagramId: 0
}
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,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Parts: 
	[
		{
			StockItemId: 0,
			Id: 0,
			Number: 0,
			InventoryId: String,
			GroupId: 0,
			Name: String,
			RetailPrice: 0,
			DealerPrice: 0,
			TradePrice: 0,
			RetailPriceNz: 0,
			TradePriceNz: 0,
			DealerPriceNz: 0,
			SalesUom: String,
			StockingIndicator: String,
			Color: String,
			ColorCode: String,
			NoteText: String,
			Coordinates: 
			[
				{
					x1: 0,
					y1: 0,
					x2: 0,
					y2: 0
				}
			],
			PartQuantity: 0,
			AvaiableQuantity: 0,
			ShowAvailabilityPopUp: False,
			IsFd: False
		}
	]
}