| 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. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class NewsletterLog
: BaseModel, IMessageLog
{
public virtual int? NewslettersId { get; set; }
[Required]
public virtual string SenderName { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual Guid? CorrelationId { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual int SendMethodId { get; set; }
[Required]
public virtual string Receiver { get; set; }
[Required]
public virtual string Sender { get; set; }
public virtual string MessageTitle { get; set; }
[Required]
public virtual string MessageBody { get; set; }
[Required]
public virtual bool Sent { get; set; }
[Required]
public virtual DateTime ToSendDate { get; set; }
public virtual DateTime? SentDate { get; set; }
public virtual int? MessageCount { get; set; }
public virtual int? SMSStatus { get; set; }
[Required]
public virtual int MessageRetries { get; set; }
public virtual string CreatedBy { get; set; }
[Required]
public virtual DateTime Created { get; set; }
public virtual string StorageUrl { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class NewsletterLogQuery
: QueryDb<NewsletterLog, NewsletterLogQueryResponse>, 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 virtual Guid? CompanyId { get; set; }
///<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 virtual bool? Sent { get; set; }
///<summary>
///Message Id
///</summary>
[ApiMember(DataType="int", Description="Message Id", ParameterType="query")]
public virtual int? Id { get; set; }
///<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 virtual string Receiver { get; set; }
///<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 virtual DateTime? Created { get; set; }
///<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 virtual DateTime? SentDate { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class NewsletterLogQueryResponse
{
///<summary>
///The message log id
///</summary>
[ApiMember(Description="The message log id")]
public virtual int Id { get; set; }
///<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 virtual string Receiver { get; set; }
///<summary>
///Nessage Title.
///</summary>
[ApiMember(Description="Nessage Title.")]
public virtual string MessageTitle { get; set; }
///<summary>
///Nessage Body.
///</summary>
[ApiMember(Description="Nessage Body.")]
public virtual string MessageBody { get; set; }
///<summary>
///When message was created.
///</summary>
[ApiMember(Description="When message was created.")]
public virtual DateTime Created { get; set; }
///<summary>
///When the message will be sent.
///</summary>
[ApiMember(Description="When the message will be sent.")]
public virtual DateTime ToSendDate { get; set; }
///<summary>
///When the message was sent.
///</summary>
[ApiMember(Description="When the message was sent.")]
public virtual DateTime? SentDate { get; set; }
///<summary>
///If Message is sent
///</summary>
[ApiMember(Description="If Message is sent")]
public virtual bool Sent { get; set; }
///<summary>
///Number of retries to send the message
///</summary>
[ApiMember(Description="Number of retries to send the message")]
public virtual int MessageRetries { get; set; }
///<summary>
///Send Method. 1 = Email, 2 = SMS
///</summary>
[ApiMember(Description="Send Method. 1 = Email, 2 = SMS")]
public virtual int SendMethodId { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<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 virtual int? Skip { get; set; }
///<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 virtual int? Take { get; set; }
///<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 virtual string OrderBy { get; set; }
///<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 virtual string OrderByDesc { get; set; }
///<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 virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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"}}}