Mds.Api

<back to all web services

Diagram

Requires Authentication
Requires the role:dealer-api-mds
The following routes are available for this service:
All Verbs/diagram/{Guid}
Diagram Parameters:
NameParameterData TypeRequiredDescription
GuidpathGuidNo
DiagramResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NameformstringNo
GuidformGuidNo
DateLastUpdateformDateTime?No
ImageformDiagramImageDetailNo
PartsformList<DiagramPartDetail>No
DiagramImageDetail Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
WidthformintNo
HeightformintNo
DiagramPartDetail Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
PartNameformstringNo
PartIdformstringNo
ImageUrlformstringNo
CoordinatesformList<Coordinate>No
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/{Guid} HTTP/1.1 
Host: mds-api.mojomotorcycles.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Guid: 00000000000000000000000000000000
}
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
		}
	},
	Name: String,
	Guid: 00000000000000000000000000000000,
	DateLastUpdate: 0001-01-01,
	Image: 
	{
		Url: String,
		Width: 0,
		Height: 0
	},
	Parts: 
	[
		{
			Number: 0,
			PartName: String,
			PartId: String,
			ImageUrl: String,
			Coordinates: 
			[
				{
					x1: 0,
					y1: 0,
					x2: 0,
					y2: 0
				}
			]
		}
	]
}