ClubManager.Api

FindProduct

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Product

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

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

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

class ProductInstance implements IConvertible
{
    int? ProductId;
    String? Group;
    String? Name;
    String? Description;
    double? Price;
    double? VAT;
    double? TotalPrice;
    int? ProductType;
    bool? Deleted;
    bool? Demo;
    int? UsageCount;
    int? StockLevel;
    int? ReorderFlag;
    bool? VisibleOnline;

    ProductInstance({this.ProductId,this.Group,this.Name,this.Description,this.Price,this.VAT,this.TotalPrice,this.ProductType,this.Deleted,this.Demo,this.UsageCount,this.StockLevel,this.ReorderFlag,this.VisibleOnline});
    ProductInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProductId = json['ProductId'];
        Group = json['Group'];
        Name = json['Name'];
        Description = json['Description'];
        Price = JsonConverters.toDouble(json['Price']);
        VAT = JsonConverters.toDouble(json['VAT']);
        TotalPrice = JsonConverters.toDouble(json['TotalPrice']);
        ProductType = json['ProductType'];
        Deleted = json['Deleted'];
        Demo = json['Demo'];
        UsageCount = json['UsageCount'];
        StockLevel = json['StockLevel'];
        ReorderFlag = json['ReorderFlag'];
        VisibleOnline = json['VisibleOnline'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProductId': ProductId,
        'Group': Group,
        'Name': Name,
        'Description': Description,
        'Price': Price,
        'VAT': VAT,
        'TotalPrice': TotalPrice,
        'ProductType': ProductType,
        'Deleted': Deleted,
        'Demo': Demo,
        'UsageCount': UsageCount,
        'StockLevel': StockLevel,
        'ReorderFlag': ReorderFlag,
        'VisibleOnline': VisibleOnline
    };

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

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Product")
class FindProduct extends QueryDb<ProductInstance> implements IConvertible
{
    FindProduct();
    FindProduct.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "FindProduct";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<T>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<T>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.clubmanagercentral.com', types: <String, TypeInfo> {
    'ProductInstance': TypeInfo(TypeOf.Class, create:() => ProductInstance()),
    'FindProduct': TypeInfo(TypeOf.Class, create:() => FindProduct()),
    'List<ProductInstance>': TypeInfo(TypeOf.Class, create:() => <ProductInstance>[]),
});

Dart FindProduct 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 /api/Query/Product HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</FindProduct>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfProductInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:ProductInstance>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:Demo>false</d2p1:Demo>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Group>String</d2p1:Group>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Price>0</d2p1:Price>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:ProductType>0</d2p1:ProductType>
      <d2p1:ReorderFlag>0</d2p1:ReorderFlag>
      <d2p1:StockLevel>0</d2p1:StockLevel>
      <d2p1:TotalPrice>0</d2p1:TotalPrice>
      <d2p1:UsageCount>0</d2p1:UsageCount>
      <d2p1:VAT>0</d2p1:VAT>
      <d2p1:VisibleOnline>false</d2p1:VisibleOnline>
    </d2p1:ProductInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</QueryResponseOfProductInstancePEZRWkv_P>