BokaMera.API.Host

BillingMethodQuery

The following routes are available for this service:
GET	/billing/methods	Get billing methods	Get all valid billing methods.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class BillingMethodQuery : QueryDb<BillingMethod, BillingMethodQueryResponse>()
{
    /**
    * If you want to only get billing methods that are valid for a specific country
    */
    @ApiMember(DataType="string", Description="If you want to only get billing methods that are valid for a specific country", ParameterType="query")
    open var CountryId:String? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var Skip:Int? = null

    @DataMember(Order=2)
    open var Take:Int? = null

    @DataMember(Order=3)
    open var OrderBy:String? = null

    @DataMember(Order=4)
    open var OrderByDesc:String? = null

    @DataMember(Order=5)
    open var Include:String? = null

    @DataMember(Order=6)
    open var Fields:String? = null

    @DataMember(Order=7)
    open var Meta:HashMap<String,String>? = null
}

open class BillingMethod : BaseModel()
{
    open var BillingMethodCountriesRelation:ArrayList<BillingMethodCountriesRelation> = ArrayList<BillingMethodCountriesRelation>()
    @Required()
    open var Name:String? = null

    @Required()
    open var Description:String? = null

    open var ModifiedDate:Date? = null
    open var Id:Int? = null
}

open class BaseModel
{
}

open class BillingMethodCountriesRelation : BaseModel()
{
    @Required()
    open var BillingMethodId:Int? = null

    @Required()
    open var CountryId:String? = null

    open var ModifiedDate:Date? = null
}

open class BillingMethodQueryResponse
{
    /**
    * The billing method id
    */
    @ApiMember(Description="The billing method id")
    open var Id:Int? = null

    /**
    * The billing method name
    */
    @ApiMember(Description="The billing method name")
    open var Name:String? = null

    /**
    * The billing method description
    */
    @ApiMember(Description="The billing method description")
    open var Description:String? = null

    /**
    * The billing method is valid for the following countries
    */
    @ApiMember(Description="The billing method is valid for the following countries")
    open var Countries:ArrayList<String> = ArrayList<String>()
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var Offset:Int? = null

    @DataMember(Order=2)
    open var Total:Int? = null

    @DataMember(Order=3)
    open var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    open var Id:Int? = null
    open var KeyType:String? = null
    open var Description:String? = null
}

Kotlin BillingMethodQuery DTOs

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

HTTP + JSON

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: testapi.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"}}}