BokaMera.API.Host

<back to all web services

SupportCaseCommentQuery

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)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
@ValidateRequest(Validator="IsAuthenticated")
open class SupportCaseCommentQuery : QueryDb<CaseComment, SupportCaseCommentsResponse>(), ICompany
{
    /**
    * Enter the company id, if blank company id and you are an admin, your company id will be used.
    */
    @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
    var CompanyId:UUID? = null

    /**
    * The support case id
    */
    @ApiMember(Description="The support case id", IsRequired=true, ParameterType="path")
    var SupportCaseId: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 CaseComment : BaseModel()
{
    @Required()
    var CompanyId:UUID? = null

    @Required()
    var SupportCaseId:Int? = null

    var Id:Int? = null
    @Required()
    var Comment:String? = null

    @Required()
    var Deleted:Boolean? = null

    @Required()
    var CreatedBy:String? = null

    @Required()
    var Created:Date? = null

    var ModifiedDate:Date? = null
}

open class BaseModel
{
}

open class SupportCaseCommentsResponse
{
    /**
    * The case id
    */
    @ApiMember(Description="The case id")
    var SupportCaseId:Int? = null

    /**
    * The comments id
    */
    @ApiMember(Description="The comments id")
    var Id:Int? = null

    /**
    * The case comment
    */
    @ApiMember(Description="The case comment")
    var Comment:String? = null

    /**
    * The case comment created by
    */
    @ApiMember(Description="The case comment created by")
    var CreatedBy:String? = null

    /**
    * The case comment created date
    */
    @ApiMember(Description="The case comment created date")
    var Created:Date? = 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 SupportCaseCommentQuery DTOs

GET /support/cases/{SupportCaseId}/comments HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			SupportCaseId: 0,
			Id: 0,
			Comment: String,
			CreatedBy: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}