ClubManager.Api

FindProduct

**Requires Authentication**
Required role:	API

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

namespace ClubManager.Api.Services.Query

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ProductInstance() = 
        member val ProductId:Int32 = new Int32() with get,set
        member val Group:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Price:Decimal = new Decimal() with get,set
        member val VAT:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ProductType:Int32 = new Int32() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val UsageCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StockLevel:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReorderFlag:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val VisibleOnline:Boolean = new Boolean() with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Product")>]
    [<AllowNullLiteral>]
    type FindProduct() = 
        inherit QueryDb<ProductInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# FindProduct 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.

POST /api/Query/Product HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			ProductId: 0,
			Group: String,
			Name: String,
			Description: String,
			Price: 0,
			VAT: 0,
			TotalPrice: 0,
			ProductType: 0,
			Deleted: False,
			Demo: False,
			UsageCount: 0,
			StockLevel: 0,
			ReorderFlag: 0,
			VisibleOnline: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}