BokaMera.API.Host

<back to all web services

MessageTypeQuery

import java.math.*
import java.util.*
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)
@ValidateRequest(Validator="IsAuthenticated")
open class MessageTypeQuery : QueryDb<MessageType, MessageTypeQueryResponse>()
{
    /**
    * The message type id.
    */
    @ApiMember(Description="The message type id.")
    var Id:Int? = null

    /**
    * The message send method id. 1 = Email, 2 = SMS
    */
    @ApiMember(Description="The message send method id. 1 = Email, 2 = SMS")
    var SendMethodId:Int? = null
}

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

@DataContract
open 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)
    var Skip:Int? = 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)
    var Take:Int? = 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)
    var OrderBy:String? = 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)
    var OrderByDesc:String? = 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)
    var Include:String? = null

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

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

open class MessageType : BaseModel()
{
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

    @Required()
    var MaxCharacters:Int? = null

    @Required()
    var DefaultText:String? = null

    @Required()
    var SendMethodId:Int? = null

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

open class BaseModel
{
}

open class MessageTypeQueryResponse
{
    /**
    * The message type id
    */
    @ApiMember(Description="The message type id")
    var Id:Int? = null

    /**
    * The message type name.
    */
    @ApiMember(Description="The message type name.")
    var Name:String? = null

    /**
    * The message type description.
    */
    @ApiMember(Description="The message type description.")
    var Description:String? = null

    /**
    * The maximum number of charachters that can be entered into message body using this type.
    */
    @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
    var MaxCharacters:Int? = null

    /**
    * The default text that is always included when sending messages of this type.
    */
    @ApiMember(Description="The default text that is always included when sending messages of this type.")
    var DefaultText:String? = null

    /**
    * The send method for this type. 1 = Email, 2 = SMS.
    */
    @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    var SendMethodId:Int? = null
}

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

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

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

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

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

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

Kotlin MessageTypeQuery DTOs

GET /messages/templates/types 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","Description":"String","MaxCharacters":0,"DefaultText":"String","SendMethodId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}