Mds.Api

<back to all web services

Part

Requires Authentication
Requires any of the roles:dealer-api-mds, dealer-api-nop
The following routes are available for this service:
All Verbs/part/{PartId}

export class PartDetail
{
    public Id: number;
    public InventoryId: string;
    public Name: string;
    public Active: boolean;
    public DateLastUpdate?: string;
    public RRP?: number;
    public TradePrice?: number;
    public DealerPrice?: number;

    public constructor(init?: Partial<PartDetail>) { (Object as any).assign(this, init); }
}

export class PartResponse
{
    public ResponseStatus: ResponseStatus;
    public IsSuccess: boolean;
    public Message: string;
    public Item: PartDetail;

    public constructor(init?: Partial<PartResponse>) { (Object as any).assign(this, init); }
}

export class Part
{
    public PartId: number;

    public constructor(init?: Partial<Part>) { (Object as any).assign(this, init); }
}

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

{
	PartId: 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
		}
	},
	IsSuccess: False,
	Message: String,
	Item: 
	{
		Id: 0,
		InventoryId: String,
		Name: String,
		Active: False,
		DateLastUpdate: 0001-01-01,
		RRP: 0,
		TradePrice: 0,
		DealerPrice: 0
	}
}