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

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class PaymentRecurrenceInstance
{
    public PaymentRecurrenceId?: number;
    public CheckDate?: string;
    public NextDate?: string;
    public EndDate?: string;
    public Amount?: number;
    public Recurrence?: number;
    public PaymentType?: number;
    public Deleted?: boolean;
    // @References("typeof(ClubManager.Api.Services.Query.MembershipInstance)")
    public MembershipId?: number;

    public ChargePerLicense?: boolean;
    public LastPaymentAmount?: number;
    public LastPaymentMethodId?: number;
    public Disabled?: boolean;

    public constructor(init?: Partial<PaymentRecurrenceInstance>) { (Object as any).assign(this, init); }
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentRecurrence")
export class FindPaymentRecurrence extends QueryDb<PaymentRecurrenceInstance>
{

    public constructor(init?: Partial<FindPaymentRecurrence>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset?: number;

    // @DataMember(Order=2)
    public Total?: number;

    // @DataMember(Order=3)
    public Results?: T[];

    // @DataMember(Order=4)
    public Meta?: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript FindPaymentRecurrence 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/PaymentRecurrence 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":[{"PaymentRecurrenceId":0,"CheckDate":"0001-01-01T00:00:00.0000000","NextDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","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"}}}