Required role: | API |
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 .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>