| Required role: | API |
| All Verbs | /api/Query/PaymentGateway |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubManager.Api.Services.Query;
namespace ClubManager.Api.Services.Query
{
[AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentGateway")]
public partial class FindPaymentGateway
: QueryDb<PaymentGatewayInstance>
{
}
public partial class PaymentGatewayInstance
{
public virtual int PaymentGatewayId { get; set; }
public virtual string Name { get; set; }
public virtual string TypeName { get; set; }
public virtual string Currency { get; set; }
public virtual string Token { get; set; }
public virtual string Metadata { get; set; }
public virtual int GatewayType { get; set; }
public virtual bool IsDefault { get; set; }
public virtual bool IsPublic { get; set; }
public virtual DateTime? Deleted { get; set; }
public virtual DateTime Created { get; set; }
public virtual DateTime AccountingStartDate { get; set; }
public virtual string BankAccount { get; set; }
public virtual DateTime? AccountingEndDate { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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/PaymentGateway HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindPaymentGateway 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>
</FindPaymentGateway>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfPaymentGatewayInstancePEZRWkv_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:PaymentGatewayInstance>
<d2p1:AccountingEndDate>0001-01-01T00:00:00</d2p1:AccountingEndDate>
<d2p1:AccountingStartDate>0001-01-01T00:00:00</d2p1:AccountingStartDate>
<d2p1:BankAccount>String</d2p1:BankAccount>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:Currency>String</d2p1:Currency>
<d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
<d2p1:GatewayType>0</d2p1:GatewayType>
<d2p1:IsDefault>false</d2p1:IsDefault>
<d2p1:IsPublic>false</d2p1:IsPublic>
<d2p1:Metadata>String</d2p1:Metadata>
<d2p1:Name>String</d2p1:Name>
<d2p1:PaymentGatewayId>0</d2p1:PaymentGatewayId>
<d2p1:Token>String</d2p1:Token>
<d2p1:TypeName>String</d2p1:TypeName>
</d2p1:PaymentGatewayInstance>
</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>
</QueryResponseOfPaymentGatewayInstancePEZRWkv_P>