| GET | /billing/methods | Get billing methods | Get all valid billing methods. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class BillingMethod
: BaseModel
{
public BillingMethod()
{
BillingMethodCountriesRelation = new List<BillingMethodCountriesRelation>{};
}
public virtual List<BillingMethodCountriesRelation> BillingMethodCountriesRelation { get; set; }
[Required]
public virtual string Name { get; set; }
[Required]
public virtual string Description { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual int Id { get; set; }
}
public partial class BillingMethodCountriesRelation
: BaseModel
{
[Required]
public virtual int BillingMethodId { get; set; }
[Required]
public virtual string CountryId { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
public partial class BillingMethodQuery
: QueryDb<BillingMethod, BillingMethodQueryResponse>
{
///<summary>
///If you want to only get billing methods that are valid for a specific country
///</summary>
[ApiMember(DataType="string", Description="If you want to only get billing methods that are valid for a specific country", ParameterType="query")]
public virtual string CountryId { get; set; }
}
public partial class BillingMethodQueryResponse
{
public BillingMethodQueryResponse()
{
Countries = new List<string>{};
}
///<summary>
///The billing method id
///</summary>
[ApiMember(Description="The billing method id")]
public virtual int Id { get; set; }
///<summary>
///The billing method name
///</summary>
[ApiMember(Description="The billing method name")]
public virtual string Name { get; set; }
///<summary>
///The billing method description
///</summary>
[ApiMember(Description="The billing method description")]
public virtual string Description { get; set; }
///<summary>
///The billing method is valid for the following countries
///</summary>
[ApiMember(Description="The billing method is valid for the following countries")]
public virtual List<string> Countries { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
///</summary>
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
///<summary>
///Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
///</summary>
[DataMember(Order=2)]
public virtual int? Take { get; set; }
///<summary>
///Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
///</summary>
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
///<summary>
///Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
///</summary>
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
///<summary>
///Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
///</summary>
[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<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
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<AccessKeyTypeResponse> 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /billing/methods HTTP/1.1 Host: api.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","Countries":["String"]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}