Required role: | API |
All Verbs | /api/Query/PaymentGateway |
---|
// @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 PaymentGatewayInstance
{
public PaymentGatewayId?: number;
public Name?: string;
public TypeName?: string;
public Currency?: string;
public Token?: string;
public Metadata?: string;
public GatewayType?: number;
public IsDefault?: boolean;
public IsPublic?: boolean;
public Deleted?: string;
public Created?: string;
public AccountingStartDate?: string;
public BankAccount?: string;
public AccountingEndDate?: string;
public constructor(init?: Partial<PaymentGatewayInstance>) { (Object as any).assign(this, init); }
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentGateway")
export class FindPaymentGateway extends QueryDb<PaymentGatewayInstance>
{
public constructor(init?: Partial<FindPaymentGateway>) { 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 FindPaymentGateway DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}