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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentGatewayInstance:
    payment_gateway_id: Optional[int] = None
    name: Optional[str] = None
    type_name: Optional[str] = None
    currency: Optional[str] = None
    token: Optional[str] = None
    metadata: Optional[str] = None
    gateway_type: Optional[int] = None
    is_default: Optional[bool] = None
    is_public: Optional[bool] = None
    deleted: Optional[datetime.datetime] = None
    created: Optional[datetime.datetime] = None
    accounting_start_date: Optional[datetime.datetime] = None
    bank_account: Optional[str] = None
    accounting_end_date: Optional[datetime.datetime] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentGateway")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindPaymentGateway(QueryDb[PaymentGatewayInstance]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: Optional[int] = None
    total: Optional[int] = None
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python 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"}}}