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}
import Foundation
import ServiceStack

public class Diagram : Codable
{
    public var guid:String

    required public init(){}
}

public class DiagramResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var name:String
    public var guid:String
    public var dateLastUpdate:Date?
    public var image:DiagramImageDetail
    public var parts:[DiagramPartDetail] = []

    required public init(){}
}

public class DiagramImageDetail : Codable
{
    public var url:String
    public var width:Int
    public var height:Int

    required public init(){}
}

public class DiagramPartDetail : Codable
{
    public var number:Int
    public var partName:String
    public var partId:String
    public var imageUrl:String
    public var coordinates:[Coordinate] = []

    required public init(){}
}

public class Coordinate : Codable
{
    public var x1:Int
    public var y1:Int
    public var x2:Int
    public var y2:Int

    required public init(){}
}


Swift Diagram DTOs

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
				}
			]
		}
	]
}