BokaMera.API.Host

<back to all web services

CompanyCreditCardInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/billing/company/creditcardGet saved credit card information for the company.Get saved credit card information for the company.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class CompanyCreditCardInformation extends QueryDb<CreditCard, CompanyCreditCardQueryResponse> implements ICompany
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;

        /**
        * If you want to include only active credit cards
        */
        @ApiMember(DataType="boolean", Description="If you want to include only active credit cards", ParameterType="query")
        public Boolean Active = null;

        /**
        * If you want to include only valid credit cards (not expired and valid)
        */
        @ApiMember(DataType="boolean", Description="If you want to include only valid credit cards (not expired and valid)", ParameterType="query")
        public Boolean IsValid = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CompanyCreditCardInformation setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isActive() { return Active; }
        public CompanyCreditCardInformation setActive(Boolean value) { this.Active = value; return this; }
        public Boolean getIsValid() { return IsValid; }
        public CompanyCreditCardInformation setIsValid(Boolean value) { this.IsValid = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        /**
        * 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>
        */
        @DataMember(Order=1)
        public Integer Skip = null;

        /**
        * 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>
        */
        @DataMember(Order=2)
        public Integer Take = null;

        /**
        * 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>
        */
        @DataMember(Order=3)
        public String OrderBy = null;

        /**
        * 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>
        */
        @DataMember(Order=4)
        public String OrderByDesc = null;

        /**
        * 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>
        */
        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class CreditCard extends BaseModel
    {
        @Ignore()
        public Boolean IsValid = null;

        @Required()
        public UUID CompanyId = null;

        public Integer Id = null;
        @Required()
        public String Name = null;

        @Required()
        public Boolean Active = null;

        @Required()
        public String Type = null;

        @Required()
        public String ExpYear = null;

        @Required()
        public String ExpMonth = null;

        @Required()
        public String TicketId = null;

        public Date Updated = null;
        public Date Created = null;
        public Date ModifiedDate = null;
        
        public Boolean getIsValid() { return IsValid; }
        public CreditCard setIsValid(Boolean value) { this.IsValid = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public CreditCard setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public CreditCard setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CreditCard setName(String value) { this.Name = value; return this; }
        public Boolean isActive() { return Active; }
        public CreditCard setActive(Boolean value) { this.Active = value; return this; }
        public String getType() { return Type; }
        public CreditCard setType(String value) { this.Type = value; return this; }
        public String getExpYear() { return ExpYear; }
        public CreditCard setExpYear(String value) { this.ExpYear = value; return this; }
        public String getExpMonth() { return ExpMonth; }
        public CreditCard setExpMonth(String value) { this.ExpMonth = value; return this; }
        public String getTicketId() { return TicketId; }
        public CreditCard setTicketId(String value) { this.TicketId = value; return this; }
        public Date getUpdated() { return Updated; }
        public CreditCard setUpdated(Date value) { this.Updated = value; return this; }
        public Date getCreated() { return Created; }
        public CreditCard setCreated(Date value) { this.Created = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public CreditCard setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class CompanyCreditCardQueryResponse
    {
        /**
        * The credit card id
        */
        @ApiMember(Description="The credit card id")
        public Integer Id = null;

        /**
        * The credit card name
        */
        @ApiMember(Description="The credit card name")
        public String Name = null;

        /**
        * If the credit card is active
        */
        @ApiMember(Description="If the credit card is active")
        public Boolean Active = null;

        /**
        * If the credit card is valid (active and not expired)
        */
        @ApiMember(Description="If the credit card is valid (active and not expired)")
        public Boolean IsValid = null;

        /**
        * The credit card type
        */
        @ApiMember(Description="The credit card type")
        public String Type = null;

        /**
        * The credit card expiration Year
        */
        @ApiMember(Description="The credit card expiration Year")
        public String ExpYear = null;

        /**
        * The credit card expiration month
        */
        @ApiMember(Description="The credit card expiration month")
        public String ExpMonth = null;

        /**
        * The credit card ticket name. This is secret information and won't be displayed
        */
        @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
        public String TicketId = null;

        /**
        * The date when the credit card was saved.
        */
        @ApiMember(Description="The date when the credit card was saved.")
        public Date Created = null;

        /**
        * The date when the credit card was updated.
        */
        @ApiMember(Description="The date when the credit card was updated.")
        public Date Updated = null;
        
        public Integer getId() { return Id; }
        public CompanyCreditCardQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CompanyCreditCardQueryResponse setName(String value) { this.Name = value; return this; }
        public Boolean isActive() { return Active; }
        public CompanyCreditCardQueryResponse setActive(Boolean value) { this.Active = value; return this; }
        public Boolean getIsValid() { return IsValid; }
        public CompanyCreditCardQueryResponse setIsValid(Boolean value) { this.IsValid = value; return this; }
        public String getType() { return Type; }
        public CompanyCreditCardQueryResponse setType(String value) { this.Type = value; return this; }
        public String getExpYear() { return ExpYear; }
        public CompanyCreditCardQueryResponse setExpYear(String value) { this.ExpYear = value; return this; }
        public String getExpMonth() { return ExpMonth; }
        public CompanyCreditCardQueryResponse setExpMonth(String value) { this.ExpMonth = value; return this; }
        public String getTicketId() { return TicketId; }
        public CompanyCreditCardQueryResponse setTicketId(String value) { this.TicketId = value; return this; }
        public Date getCreated() { return Created; }
        public CompanyCreditCardQueryResponse setCreated(Date value) { this.Created = value; return this; }
        public Date getUpdated() { return Updated; }
        public CompanyCreditCardQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

Java CompanyCreditCardInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Active":false,"IsValid":false,"Type":"String","ExpYear":"String","ExpMonth":"String","TicketId":"String","Created":"0001-01-01T00:00:00","Updated":"0001-01-01T00:00:00"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}