| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter 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 EmailTemplate
Inherits BaseModel
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Description As String
<Required>
Public Overridable Property Body As String
<Required>
Public Overridable Property Type As Integer
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
Public Overridable Property Id As Integer
End Class
Public Partial Class NewsletterTemplate
Inherits BaseModel
Public Overridable Property SendMethod As SendMethod
Public Overridable Property EmailTemplate As EmailTemplate
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property Heading As String
<Required>
Public Overridable Property Body As String
Public Overridable Property ImageUrl As String
<Required>
Public Overridable Property SendMethodId As Integer
Public Overridable Property EmailTemplateId As Nullable(Of Integer)
<Required>
Public Overridable Property Created As Date
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
End Class
Public Partial Class SendMethod
Inherits BaseModel
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Description As String
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
Public Partial Class NewsletterEmailTemplatesQueryResponse
'''<Summary>
'''The email template id
'''</Summary>
<ApiMember(Description:="The email template id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The email template name.
'''</Summary>
<ApiMember(Description:="The email template name.")>
Public Overridable Property Name As String
'''<Summary>
'''The email template description.
'''</Summary>
<ApiMember(Description:="The email template description.")>
Public Overridable Property Description As String
'''<Summary>
'''The email template html content.
'''</Summary>
<ApiMember(Description:="The email template html content.")>
Public Overridable Property Body As String
End Class
Public Partial Class NewsletterSendMethodQueryResponse
'''<Summary>
'''The send method id
'''</Summary>
<ApiMember(Description:="The send method id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The send method name.
'''</Summary>
<ApiMember(Description:="The send method name.")>
Public Overridable Property Name As String
'''<Summary>
'''The send method description.
'''</Summary>
<ApiMember(Description:="The send method description.")>
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 NewsletterTemplatesQuery
Inherits QueryDb(Of NewsletterTemplate, NewsletterTemplatesQueryResponse)
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.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''The newsletter template id.
'''</Summary>
<ApiMember(Description:="The newsletter template id.")>
Public Overridable Property Id As Nullable(Of Integer)
'''<Summary>
'''If you want to include the message send method information
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the message send method information", ParameterType:="query")>
Public Overridable Property IncludeSendMethodInformation As Boolean
'''<Summary>
'''If you want to include the email template information
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the email template information", ParameterType:="query")>
Public Overridable Property IncludeEmailTemplateInformation As Boolean
End Class
Public Partial Class NewsletterTemplatesQueryResponse
'''<Summary>
'''The newsletter template id
'''</Summary>
<ApiMember(Description:="The newsletter template id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The newsletter template heading.
'''</Summary>
<ApiMember(Description:="The newsletter template heading.")>
Public Overridable Property Heading As String
'''<Summary>
'''The newsletter template body.
'''</Summary>
<ApiMember(Description:="The newsletter template body.")>
Public Overridable Property Body As String
'''<Summary>
'''The email template the newsletter uses.
'''</Summary>
<ApiMember(Description:="The email template the newsletter uses.")>
Public Overridable Property EmailTemplateId As Nullable(Of Integer)
'''<Summary>
'''Send Method. 1 = Email, 2 = SMS
'''</Summary>
<ApiMember(Description:="Send Method. 1 = Email, 2 = SMS")>
Public Overridable Property SendMethodId As Integer
'''<Summary>
'''The newsletter template image url.
'''</Summary>
<ApiMember(Description:="The newsletter template image url.")>
Public Overridable Property ImageUrl As String
'''<Summary>
'''The newsletter created date.
'''</Summary>
<ApiMember(Description:="The newsletter created date.")>
Public Overridable Property Created As Date
'''<Summary>
'''Send method information.
'''</Summary>
<ApiMember(Description:="Send method information.")>
Public Overridable Property SendMethodInformation As NewsletterSendMethodQueryResponse
'''<Summary>
'''Email template information.
'''</Summary>
<ApiMember(Description:="Email template information.")>
Public Overridable Property EmailTemplateInformation As NewsletterEmailTemplatesQueryResponse
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 NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/templates HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfNewsletterTemplatesQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:NewsletterTemplatesQueryResponse>
<d2p1:Body>String</d2p1:Body>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:EmailTemplateId>0</d2p1:EmailTemplateId>
<d2p1:EmailTemplateInformation>
<d2p1:Body>String</d2p1:Body>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:EmailTemplateInformation>
<d2p1:Heading>String</d2p1:Heading>
<d2p1:Id>0</d2p1:Id>
<d2p1:ImageUrl>String</d2p1:ImageUrl>
<d2p1:SendMethodId>0</d2p1:SendMethodId>
<d2p1:SendMethodInformation>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:SendMethodInformation>
</d2p1:NewsletterTemplatesQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfNewsletterTemplatesQueryResponseWg5EthtI>