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}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class ModelResponse implements IConvertible
{
    int? Id;
    String? Name;
    bool? Published;

    ModelResponse({this.Id,this.Name,this.Published});
    ModelResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Published = json['Published'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Published': Published
    };

    getTypeName() => "ModelResponse";
    TypeContext? context = _ctx;
}

class ModelsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    bool? IsSuccess;
    String? Message;
    List<ModelResponse>? Items;

    ModelsResponse({this.ResponseStatus,this.IsSuccess,this.Message,this.Items});
    ModelsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        IsSuccess = json['IsSuccess'];
        Message = json['Message'];
        Items = JsonConverters.fromJson(json['Items'],'List<ModelResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'IsSuccess': IsSuccess,
        'Message': Message,
        'Items': JsonConverters.toJson(Items,'List<ModelResponse>',context!)
    };

    getTypeName() => "ModelsResponse";
    TypeContext? context = _ctx;
}

class Models implements IConvertible
{
    int? TypeId;

    Models({this.TypeId});
    Models.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TypeId = json['TypeId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TypeId': TypeId
    };

    getTypeName() => "Models";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'mds_api.mojomotorcycles.com.au', types: <String, TypeInfo> {
    'ModelResponse': TypeInfo(TypeOf.Class, create:() => ModelResponse()),
    'ModelsResponse': TypeInfo(TypeOf.Class, create:() => ModelsResponse()),
    'List<ModelResponse>': TypeInfo(TypeOf.Class, create:() => <ModelResponse>[]),
    'Models': TypeInfo(TypeOf.Class, create:() => Models()),
});

Dart Models DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Models xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mds.Api.ServiceModel">
  <TypeId>0</TypeId>
</Models>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ModelsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mds.Api.ServiceModel">
  <IsSuccess>false</IsSuccess>
  <Items>
    <ModelResponse>
      <Id>0</Id>
      <Name>String</Name>
      <Published>false</Published>
    </ModelResponse>
  </Items>
  <Message>String</Message>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ModelsResponse>