OSZZ API

<back to all web services

Search

The following routes are available for this service:
GET/search
GET/{Ver}/search

// @DataContract
export class SearchResponse implements IResponse
{
    // @DataMember
    public responseStatus?: ResponseStatus;

    // @DataMember
    public result?: ProductModel[];

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

// @DataContract
export class Search
{
    // @DataMember
    public q?: string;

    // @DataMember
    public tokenId?: string;

    // @DataMember
    public ver?: number;

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

// @DataContract
export class ProductModel
{
    // @DataMember
    public id?: string;

    // @DataMember
    public manufacturerTitle?: string;

    // @DataMember
    public number?: string;

    // @DataMember
    public title?: string;

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

TypeScript Search DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}