| GET | /sales/package/{PackageId} | Get sales package details |
|---|
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type GetSalesPackageRequestDto() =
inherit ApiDtoBase()
member val PackageId:Int32 = new Int32() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type GetSalesPackageRequest() =
inherit GetSalesPackageRequestDto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///ID # of store to get package details for. <br//> Either StoreId or ChainId is required
///</summary>
[<ApiMember(DataType="string", Description="ID # of store to get package details for. <br//> Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///ID # of chain to get package details for. <br//> Either StoreId or ChainId is required
///</summary>
[<ApiMember(DataType="string", Description="ID # of chain to get package details for. <br//> Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")>]
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///ID # of package to get details for
///</summary>
[<ApiMember(DataType="string", Description="ID # of package to get details for", IsRequired=true, Name="PackageId", ParameterType="path")>]
member val PackageId:Int32 = new Int32() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
F# GetSalesPackageRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sales/package/{PackageId} HTTP/1.1
Host: clubready.com
Accept: text/csv