ClubManager.Api

FindOrder

**Requires Authentication**
Required role:	API

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

import Foundation
import ServiceStack

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Order")
public class FindOrder : QueryDb<OrderInstance>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class OrderInstance : Codable
{
    public var orderId:Int?
    public var orderNumber:String?
    public var orderCode:String?
    public var orderAmount:Double?
    public var receivedDateTime:Date?
    public var completedDateTime:Date?
    public var refundedDateTime:Date?
    public var orderFee:Double?

    required public init(){}
}

Swift FindOrder 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/Order 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: 
	[
		{
			OrderId: 0,
			OrderNumber: String,
			OrderCode: String,
			OrderAmount: 0,
			ReceivedDateTime: 0001-01-01,
			CompletedDateTime: 0001-01-01,
			RefundedDateTime: 0001-01-01,
			OrderFee: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}