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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiagramImageDetail:
    url: Optional[str] = None
    width: int = 0
    height: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Coordinate:
    x1: int = 0
    y1: int = 0
    x2: int = 0
    y2: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiagramPartDetail:
    number: int = 0
    part_name: Optional[str] = None
    part_id: Optional[str] = None
    image_url: Optional[str] = None
    coordinates: Optional[List[Coordinate]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiagramResponse:
    response_status: Optional[ResponseStatus] = None
    name: Optional[str] = None
    guid: Optional[str] = None
    date_last_update: Optional[datetime.datetime] = None
    image: Optional[DiagramImageDetail] = None
    parts: Optional[List[DiagramPartDetail]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Diagram:
    guid: Optional[str] = None

Python Diagram DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Guid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":"\/Date(-62135596800000-0000)\/","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}]}]}