Mds.Api

<back to all web services

Models

Requires Authentication
Requires any of the roles:dealer-api-mds, dealer-api-nop
The following routes are available for this service:
All Verbs/models/{TypeId}
Models Parameters:
NameParameterData TypeRequiredDescription
TypeIdpathintNo
ModelsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IsSuccessformboolNo
MessageformstringNo
ItemsformList<ModelResponse>No
ModelResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
PublishedformboolNo

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

{
	TypeId: 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,
	Items: 
	[
		{
			Id: 0,
			Name: String,
			Published: False
		}
	]
}