| GET | /messages/templates/types | Get message types | Get all message types used by the message templates. |
|---|
Imports System
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 MessageType
Inherits BaseModel
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Description As String
<Required>
Public Overridable Property MaxCharacters As Integer
<Required>
Public Overridable Property DefaultText As String
<Required>
Public Overridable Property SendMethodId As Integer
Public Overridable Property ModifiedDate As Nullable(Of 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)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class MessageTypeQuery
Inherits QueryDb(Of MessageType, MessageTypeQueryResponse)
'''<Summary>
'''The message type id.
'''</Summary>
<ApiMember(Description:="The message type id.")>
Public Overridable Property Id As Nullable(Of Integer)
'''<Summary>
'''The message send method id. 1 = Email, 2 = SMS
'''</Summary>
<ApiMember(Description:="The message send method id. 1 = Email, 2 = SMS")>
Public Overridable Property SendMethodId As Nullable(Of Integer)
End Class
Public Partial Class MessageTypeQueryResponse
'''<Summary>
'''The message type id
'''</Summary>
<ApiMember(Description:="The message type id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The message type name.
'''</Summary>
<ApiMember(Description:="The message type name.")>
Public Overridable Property Name As String
'''<Summary>
'''The message type description.
'''</Summary>
<ApiMember(Description:="The message type description.")>
Public Overridable Property Description As String
'''<Summary>
'''The maximum number of charachters that can be entered into message body using this type.
'''</Summary>
<ApiMember(Description:="The maximum number of charachters that can be entered into message body using this type.")>
Public Overridable Property MaxCharacters As Integer
'''<Summary>
'''The default text that is always included when sending messages of this type.
'''</Summary>
<ApiMember(Description:="The default text that is always included when sending messages of this type.")>
Public Overridable Property DefaultText As String
'''<Summary>
'''The send method for this type. 1 = Email, 2 = SMS.
'''</Summary>
<ApiMember(Description:="The send method for this type. 1 = Email, 2 = SMS.")>
Public Overridable Property SendMethodId As Integer
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of Integer)
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=3)>
Public Overridable Property OrderBy As String
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=4)>
Public Overridable Property OrderByDesc As String
'''<Summary>
'''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>
'''</Summary>
<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 AccessKeyTypeResponse)
Public Sub New()
Results = New List(Of AccessKeyTypeResponse)
Meta = New Dictionary(Of String, String)
End Sub
<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)
<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
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /messages/templates/types HTTP/1.1 Host: api.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","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"}}}