| Required role: | API |
| All Verbs | /api/Query/PaymentRecurrence |
|---|
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 PaymentRecurrenceInstance() =
member val PaymentRecurrenceId:Int32 = new Int32() with get,set
member val CheckDate:DateTime = new DateTime() with get,set
member val NextDate:DateTime = new DateTime() with get,set
member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Amount:Decimal = new Decimal() with get,set
member val Recurrence:Int32 = new Int32() with get,set
member val PaymentType:Int32 = new Int32() with get,set
member val Deleted:Boolean = new Boolean() with get,set
[<References(typeof<MembershipInstance>)>]
member val MembershipId:Int32 = new Int32() with get,set
member val ChargePerLicense:Boolean = new Boolean() with get,set
member val LastPaymentAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LastPaymentMethodId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Disabled:Boolean = new Boolean() with get,set
[<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentRecurrence")>]
[<AllowNullLiteral>]
type FindPaymentRecurrence() =
inherit QueryDb<PaymentRecurrenceInstance>()
[<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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/PaymentRecurrence HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindPaymentRecurrence 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>
</FindPaymentRecurrence>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfPaymentRecurrenceInstancePEZRWkv_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:PaymentRecurrenceInstance>
<d2p1:Amount>0</d2p1:Amount>
<d2p1:ChargePerLicense>false</d2p1:ChargePerLicense>
<d2p1:CheckDate>0001-01-01T00:00:00</d2p1:CheckDate>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:Disabled>false</d2p1:Disabled>
<d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
<d2p1:LastPaymentAmount>0</d2p1:LastPaymentAmount>
<d2p1:LastPaymentMethodId>0</d2p1:LastPaymentMethodId>
<d2p1:MembershipId>0</d2p1:MembershipId>
<d2p1:NextDate>0001-01-01T00:00:00</d2p1:NextDate>
<d2p1:PaymentRecurrenceId>0</d2p1:PaymentRecurrenceId>
<d2p1:PaymentType>0</d2p1:PaymentType>
<d2p1:Recurrence>0</d2p1:Recurrence>
</d2p1:PaymentRecurrenceInstance>
</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>
</QueryResponseOfPaymentRecurrenceInstancePEZRWkv_P>