ClubManager.Api

<back to all web services

FindPaymentRecurrence

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/PaymentRecurrence
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Api.Services.Query

Namespace Global

    Namespace ClubManager.Api.Services.Query

        <AutoQueryViewer(Description:="", IconUrl:="octicon:database", Title:="PaymentRecurrence")>
        Public Partial Class FindPaymentRecurrence
            Inherits QueryDb(Of PaymentRecurrenceInstance)
        End Class

        Public Partial Class PaymentRecurrenceInstance
            Public Overridable Property PaymentRecurrenceId As Integer
            Public Overridable Property CheckDate As Date
            Public Overridable Property NextDate As Date
            Public Overridable Property EndDate As Nullable(Of Date)
            Public Overridable Property Amount As Decimal
            Public Overridable Property Recurrence As Integer
            Public Overridable Property PaymentType As Integer
            Public Overridable Property Deleted As Boolean
            <References(GetType(MembershipInstance))>
            Public Overridable Property MembershipId As Integer

            Public Overridable Property ChargePerLicense As Boolean
            Public Overridable Property LastPaymentAmount As Nullable(Of Decimal)
            Public Overridable Property LastPaymentMethodId As Nullable(Of Integer)
            Public Overridable Property Disabled As Boolean
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET FindPaymentRecurrence 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/PaymentRecurrence 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: 
	[
		{
			PaymentRecurrenceId: 0,
			CheckDate: 0001-01-01,
			NextDate: 0001-01-01,
			EndDate: 0001-01-01,
			Amount: 0,
			Recurrence: 0,
			PaymentType: 0,
			Deleted: False,
			MembershipId: 0,
			ChargePerLicense: False,
			LastPaymentAmount: 0,
			LastPaymentMethodId: 0,
			Disabled: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}