| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/log | Search the newsletter log for any messages | Search the newsletter log for any messages. |
|---|
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 NewsletterLog
Inherits BaseModel
Implements IMessageLog
Public Overridable Property NewslettersId As Nullable(Of Integer)
<Required>
Public Overridable Property SenderName As String
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
Public Overridable Property CorrelationId As Nullable(Of Guid)
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property SendMethodId As Integer
<Required>
Public Overridable Property Receiver As String
<Required>
Public Overridable Property Sender As String
Public Overridable Property MessageTitle As String
<Required>
Public Overridable Property MessageBody As String
<Required>
Public Overridable Property Sent As Boolean
<Required>
Public Overridable Property ToSendDate As Date
Public Overridable Property SentDate As Nullable(Of Date)
Public Overridable Property MessageCount As Nullable(Of Integer)
Public Overridable Property SMSStatus As Nullable(Of Integer)
<Required>
Public Overridable Property MessageRetries As Integer
Public Overridable Property CreatedBy As String
<Required>
Public Overridable Property Created As Date
Public Overridable Property StorageUrl As String
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 NewsletterLogQuery
Inherits QueryDb(Of NewsletterLog, NewsletterLogQueryResponse)
Implements ICompany
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.", ParameterType:="path")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''If you want to search on sent messages
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to search on sent messages", ParameterType:="query")>
Public Overridable Property Sent As Nullable(Of Boolean)
'''<Summary>
'''Message Id
'''</Summary>
<ApiMember(DataType:="int", Description:="Message Id", ParameterType:="query")>
Public Overridable Property Id As Nullable(Of Integer)
'''<Summary>
'''If you want to search on a messages for a specific receiver
'''</Summary>
<ApiMember(DataType:="string", Description:="If you want to search on a messages for a specific receiver", ParameterType:="query")>
Public Overridable Property Receiver As String
'''<Summary>
'''If you want to search on a messages created a specific date
'''</Summary>
<ApiMember(DataType:="datetime", Description:="If you want to search on a messages created a specific date", ParameterType:="query")>
Public Overridable Property Created As Nullable(Of Date)
'''<Summary>
'''If you want to search on a messages sent a specific date
'''</Summary>
<ApiMember(DataType:="datetime", Description:="If you want to search on a messages sent a specific date", ParameterType:="query")>
Public Overridable Property SentDate As Nullable(Of Date)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class NewsletterLogQueryResponse
'''<Summary>
'''The message log id
'''</Summary>
<ApiMember(Description:="The message log id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The message receiver. Either a email or a mobile phone number.
'''</Summary>
<ApiMember(Description:="The message receiver. Either a email or a mobile phone number.")>
Public Overridable Property Receiver As String
'''<Summary>
'''Nessage Title.
'''</Summary>
<ApiMember(Description:="Nessage Title.")>
Public Overridable Property MessageTitle As String
'''<Summary>
'''Nessage Body.
'''</Summary>
<ApiMember(Description:="Nessage Body.")>
Public Overridable Property MessageBody As String
'''<Summary>
'''When message was created.
'''</Summary>
<ApiMember(Description:="When message was created.")>
Public Overridable Property Created As Date
'''<Summary>
'''When the message will be sent.
'''</Summary>
<ApiMember(Description:="When the message will be sent.")>
Public Overridable Property ToSendDate As Date
'''<Summary>
'''When the message was sent.
'''</Summary>
<ApiMember(Description:="When the message was sent.")>
Public Overridable Property SentDate As Nullable(Of Date)
'''<Summary>
'''If Message is sent
'''</Summary>
<ApiMember(Description:="If Message is sent")>
Public Overridable Property Sent As Boolean
'''<Summary>
'''Number of retries to send the message
'''</Summary>
<ApiMember(Description:="Number of retries to send the message")>
Public Overridable Property MessageRetries As Integer
'''<Summary>
'''Send Method. 1 = Email, 2 = SMS
'''</Summary>
<ApiMember(Description:="Send Method. 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
VB.NET NewsletterLogQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/log 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,"Receiver":"String","MessageTitle":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"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"}}}