| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company/creditcard | Get saved credit card information for the company. | Get saved credit card information for the company. |
|---|
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 CreditCard
: BaseModel
{
[Ignore]
public virtual bool IsValid { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string Name { get; set; }
[Required]
public virtual bool Active { get; set; }
[Required]
public virtual string Type { get; set; }
[Required]
public virtual string ExpYear { get; set; }
[Required]
public virtual string ExpMonth { get; set; }
[Required]
public virtual string TicketId { get; set; }
public virtual DateTime? Updated { get; set; }
public virtual DateTime? Created { 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)]
[ValidateRequest("IsAuthenticated")]
public partial class CompanyCreditCardInformation
: QueryDb<CreditCard, CompanyCreditCardQueryResponse>, ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///If you want to include only active credit cards
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include only active credit cards", ParameterType="query")]
public virtual bool Active { get; set; }
///<summary>
///If you want to include only valid credit cards (not expired and valid)
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include only valid credit cards (not expired and valid)", ParameterType="query")]
public virtual bool IsValid { get; set; }
}
public partial class CompanyCreditCardQueryResponse
{
///<summary>
///The credit card id
///</summary>
[ApiMember(Description="The credit card id")]
public virtual int Id { get; set; }
///<summary>
///The credit card name
///</summary>
[ApiMember(Description="The credit card name")]
public virtual string Name { get; set; }
///<summary>
///If the credit card is active
///</summary>
[ApiMember(Description="If the credit card is active")]
public virtual bool Active { get; set; }
///<summary>
///If the credit card is valid (active and not expired)
///</summary>
[ApiMember(Description="If the credit card is valid (active and not expired)")]
public virtual bool IsValid { get; set; }
///<summary>
///The credit card type
///</summary>
[ApiMember(Description="The credit card type")]
public virtual string Type { get; set; }
///<summary>
///The credit card expiration Year
///</summary>
[ApiMember(Description="The credit card expiration Year")]
public virtual string ExpYear { get; set; }
///<summary>
///The credit card expiration month
///</summary>
[ApiMember(Description="The credit card expiration month")]
public virtual string ExpMonth { get; set; }
///<summary>
///The credit card ticket name. This is secret information and won't be displayed
///</summary>
[ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")]
public virtual string TicketId { get; set; }
///<summary>
///The date when the credit card was saved.
///</summary>
[ApiMember(Description="The date when the credit card was saved.")]
public virtual DateTime? Created { get; set; }
///<summary>
///The date when the credit card was updated.
///</summary>
[ApiMember(Description="The date when the credit card was updated.")]
public virtual DateTime? Updated { 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; }
}
}
C# CompanyCreditCardInformation 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.
GET /billing/company/creditcard HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfCompanyCreditCardQueryResponseWg5EthtI 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/BokaMera.API.ServiceModel.Dtos">
<d2p1:CompanyCreditCardQueryResponse>
<d2p1:Active>false</d2p1:Active>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:ExpMonth>String</d2p1:ExpMonth>
<d2p1:ExpYear>String</d2p1:ExpYear>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsValid>false</d2p1:IsValid>
<d2p1:Name>String</d2p1:Name>
<d2p1:TicketId>String</d2p1:TicketId>
<d2p1:Type>String</d2p1:Type>
<d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
</d2p1:CompanyCreditCardQueryResponse>
</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>
</QueryResponseOfCompanyCreditCardQueryResponseWg5EthtI>