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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class Diagram
    {
        public UUID Guid = null;
        
        public UUID getGuid() { return Guid; }
        public Diagram setGuid(UUID value) { this.Guid = value; return this; }
    }

    public static class DiagramResponse
    {
        public ResponseStatus ResponseStatus = null;
        public String Name = null;
        public UUID Guid = null;
        public Date DateLastUpdate = null;
        public DiagramImageDetail Image = null;
        public ArrayList<DiagramPartDetail> Parts = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DiagramResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public String getName() { return Name; }
        public DiagramResponse setName(String value) { this.Name = value; return this; }
        public UUID getGuid() { return Guid; }
        public DiagramResponse setGuid(UUID value) { this.Guid = value; return this; }
        public Date getDateLastUpdate() { return DateLastUpdate; }
        public DiagramResponse setDateLastUpdate(Date value) { this.DateLastUpdate = value; return this; }
        public DiagramImageDetail getImage() { return Image; }
        public DiagramResponse setImage(DiagramImageDetail value) { this.Image = value; return this; }
        public ArrayList<DiagramPartDetail> getParts() { return Parts; }
        public DiagramResponse setParts(ArrayList<DiagramPartDetail> value) { this.Parts = value; return this; }
    }

    public static class DiagramImageDetail
    {
        public String Url = null;
        public Integer Width = null;
        public Integer Height = null;
        
        public String getUrl() { return Url; }
        public DiagramImageDetail setUrl(String value) { this.Url = value; return this; }
        public Integer getWidth() { return Width; }
        public DiagramImageDetail setWidth(Integer value) { this.Width = value; return this; }
        public Integer getHeight() { return Height; }
        public DiagramImageDetail setHeight(Integer value) { this.Height = value; return this; }
    }

    public static class DiagramPartDetail
    {
        public Integer Number = null;
        public String PartName = null;
        public String PartId = null;
        public String ImageUrl = null;
        public ArrayList<Coordinate> Coordinates = null;
        
        public Integer getNumber() { return Number; }
        public DiagramPartDetail setNumber(Integer value) { this.Number = value; return this; }
        public String getPartName() { return PartName; }
        public DiagramPartDetail setPartName(String value) { this.PartName = value; return this; }
        public String getPartId() { return PartId; }
        public DiagramPartDetail setPartId(String value) { this.PartId = value; return this; }
        public String getImageUrl() { return ImageUrl; }
        public DiagramPartDetail setImageUrl(String value) { this.ImageUrl = value; return this; }
        public ArrayList<Coordinate> getCoordinates() { return Coordinates; }
        public DiagramPartDetail setCoordinates(ArrayList<Coordinate> value) { this.Coordinates = value; return this; }
    }

    public static class Coordinate
    {
        public Integer x1 = null;
        public Integer y1 = null;
        public Integer x2 = null;
        public Integer y2 = null;
        
        public Integer getX1() { return x1; }
        public Coordinate setX1(Integer value) { this.x1 = value; return this; }
        public Integer getY1() { return y1; }
        public Coordinate setY1(Integer value) { this.y1 = value; return this; }
        public Integer getX2() { return x2; }
        public Coordinate setX2(Integer value) { this.x2 = value; return this; }
        public Integer getY2() { return y2; }
        public Coordinate setY2(Integer value) { this.y2 = value; return this; }
    }

}

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