GET | /todos |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports MyApp.ServiceModel
Namespace Global
Namespace MyApp.ServiceModel
Public Partial Class QueryTodos
Inherits QueryData(Of Todo)
Public Overridable Property Id As Nullable(Of Integer)
Public Overridable Property Ids As List(Of Long)
Public Overridable Property TextContains As String
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of 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 Todo
Public Overridable Property Id As Long
Public Overridable Property Text As String
Public Overridable Property IsFinished As Boolean
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of 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 QueryData(Of T)
Inherits QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of 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
<DataContract>
Public Partial Class QueryResponse(Of Todo)
Public Sub New()
Results = New List(Of Todo)
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 Todo)
<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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /todos HTTP/1.1 Host: vue-vite-api.jamstacks.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: 0, text: String, isFinished: False } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }