ClubManager.Api

<back to all web services

FindPaymentGateway

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/PaymentGateway
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:="PaymentGateway")>
        Public Partial Class FindPaymentGateway
            Inherits QueryDb(Of PaymentGatewayInstance)
        End Class

        Public Partial Class PaymentGatewayInstance
            Public Overridable Property PaymentGatewayId As Integer
            Public Overridable Property Name As String
            Public Overridable Property TypeName As String
            Public Overridable Property Currency As String
            Public Overridable Property Token As String
            Public Overridable Property Metadata As String
            Public Overridable Property GatewayType As Integer
            Public Overridable Property IsDefault As Boolean
            Public Overridable Property IsPublic As Boolean
            Public Overridable Property Deleted As Nullable(Of Date)
            Public Overridable Property Created As Date
            Public Overridable Property AccountingStartDate As Date
            Public Overridable Property BankAccount As String
            Public Overridable Property AccountingEndDate As Nullable(Of Date)
        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 FindPaymentGateway DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Query/PaymentGateway HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"PaymentGatewayId":0,"Name":"String","TypeName":"String","Currency":"String","Token":"String","Metadata":"String","GatewayType":0,"IsDefault":false,"IsPublic":false,"Deleted":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","AccountingStartDate":"0001-01-01T00:00:00.0000000","BankAccount":"String","AccountingEndDate":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}