OSZZ API

<back to all web services

Search

The following routes are available for this service:
GET/search
GET/{Ver}/search
import 'package:servicestack/servicestack.dart';

// @DataContract
class SearchResponse implements IResponse, IConvertible
{
    // @DataMember
    ResponseStatus? responseStatus;

    // @DataMember
    List<ProductModel>? result;

    SearchResponse({this.responseStatus,this.result});
    SearchResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        result = JsonConverters.fromJson(json['result'],'List<ProductModel>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'result': JsonConverters.toJson(result,'List<ProductModel>',context!)
    };

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

// @DataContract
class Search implements IConvertible
{
    // @DataMember
    String? q;

    // @DataMember
    String? tokenId;

    // @DataMember
    int? ver;

    Search({this.q,this.tokenId,this.ver});
    Search.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'q': q,
        'tokenId': tokenId,
        'ver': ver
    };

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

// @DataContract
class ProductModel implements IConvertible
{
    // @DataMember
    String? id;

    // @DataMember
    String? manufacturerTitle;

    // @DataMember
    String? number;

    // @DataMember
    String? title;

    ProductModel({this.id,this.manufacturerTitle,this.number,this.title});
    ProductModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        manufacturerTitle = json['manufacturerTitle'];
        number = json['number'];
        title = json['title'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'manufacturerTitle': manufacturerTitle,
        'number': number,
        'title': title
    };

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

TypeContext _ctx = TypeContext(library: 'api.oszz.ru', types: <String, TypeInfo> {
    'SearchResponse': TypeInfo(TypeOf.Class, create:() => SearchResponse()),
    'List<ProductModel>': TypeInfo(TypeOf.Class, create:() => <ProductModel>[]),
    'ProductModel': TypeInfo(TypeOf.Class, create:() => ProductModel()),
    'Search': TypeInfo(TypeOf.Class, create:() => Search()),
});

Dart Search 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.

GET /search HTTP/1.1 
Host: api.oszz.ru 
Accept: text/jsv
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
		}
	},
	result: 
	[
		{
			id: 00000000000000000000000000000000,
			manufacturerTitle: String,
			number: String,
			title: String
		}
	]
}