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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mds.Api.ServiceModel

Namespace Global

    Namespace Mds.Api.ServiceModel

        Public Partial Class Part
            Public Overridable Property PartId As Integer
        End Class

        Public Partial Class PartDetail
            Public Overridable Property Id As Integer
            Public Overridable Property InventoryId As String
            Public Overridable Property Name As String
            Public Overridable Property Active As Boolean
            Public Overridable Property DateLastUpdate As Nullable(Of Date)
            Public Overridable Property RRP As Nullable(Of Decimal)
            Public Overridable Property TradePrice As Nullable(Of Decimal)
            Public Overridable Property DealerPrice As Nullable(Of Decimal)
        End Class

        Public Partial Class PartResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property IsSuccess As Boolean
            Public Overridable Property Message As String
            Public Overridable Property Item As PartDetail
        End Class
    End Namespace
End Namespace

VB.NET 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
	}
}