BokaMera.API.Host

SuperAdminSupportCaseAreaQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
GET	/superadmin/support/cases/areas	Get all valid support case areas	Get all valid support case areas.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class CaseArea
            Inherits BaseModel
            <Required>
            Public Overridable Property Name As String

            <Required>
            Public Overridable Property Description As String

            Public Overridable Property ModifiedDate As DateTimeOffset?
            Public Overridable Property Id As Integer
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        <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")>
        Public Partial Class SuperAdminSupportCaseAreaQuery
            Inherits QueryDb(Of CaseArea, SupportCaseAreaResponse)
        End Class

        Public Partial Class SupportCaseAreaResponse
            '''<Summary>
            '''The area id
            '''</Summary>
            <ApiMember(Description:="The area id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The area name
            '''</Summary>
            <ApiMember(Description:="The area name")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The area description
            '''</Summary>
            <ApiMember(Description:="The area description")>
            Public Overridable Property Description As String
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Integer?

            <DataMember(Order:=2)>
            Public Overridable Property Take As Integer?

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse) = New List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET SuperAdminSupportCaseAreaQuery DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /superadmin/support/cases/areas HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String,
			Description: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}