BokaMera.API.Host

<back to all web services

MessageLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/messages/logSearch the message log for any messagesSearch the message 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 MessageLog
        : BaseModel, IMessageLog
    {
        public virtual int? BookingId { get; set; }
        [Required]
        public virtual bool PublicMessage { get; set; }

        [Required]
        public virtual int MessageType { get; set; }

        [Required]
        public virtual bool iCalAttachment { 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 string Receiver { get; set; }

        [Required]
        public virtual string Sender { get; set; }

        public virtual string MessageTitle { get; set; }
        [Required]
        public virtual string MessageBody { get; set; }

        public virtual string CreatedBy { get; set; }
        [Required]
        public virtual DateTime Created { get; set; }

        [Required]
        public virtual bool Sent { get; set; }

        [Required]
        public virtual DateTime ToSendDate { get; set; }

        public virtual DateTime? SentDate { get; set; }
        [Required]
        public virtual int SendMethodId { get; set; }

        public virtual int? MessageCount { get; set; }
        public virtual int? SMSStatus { get; set; }
        [Required]
        public virtual int MessageRetries { get; set; }

        public virtual string StorageUrl { get; set; }
        public virtual string Language { 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 MessageLogQuery
        : QueryDb<MessageLog, MessageLogQueryResponse>, 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 booking
        ///</summary>
        [ApiMember(DataType="int", Description="If you want to search on a messages for a specific booking", ParameterType="query")]
        public virtual int? BookingId { 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 MessageLogQueryResponse
    {
        ///<summary>
        ///The message log id
        ///</summary>
        [ApiMember(Description="The message log id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The booking id for the message (if connected to a booking).
        ///</summary>
        [ApiMember(Description="The booking id for the message (if connected to a booking).")]
        public virtual int? BookingId { 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>
        ///Message Title.
        ///</summary>
        [ApiMember(Description="Message Title.")]
        public virtual string MessageTitle { get; set; }

        ///<summary>
        ///Message Storage Url.
        ///</summary>
        [ApiMember(Description="Message Storage Url.")]
        public virtual string StorageUrl { get; set; }

        ///<summary>
        ///Message Body.
        ///</summary>
        [ApiMember(Description="Message 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; }
    }

}

C# MessageLogQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /messages/log HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfMessageLogQueryResponseWg5EthtI 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:MessageLogQueryResponse>
      <d2p1:BookingId>0</d2p1:BookingId>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MessageBody>String</d2p1:MessageBody>
      <d2p1:MessageRetries>0</d2p1:MessageRetries>
      <d2p1:MessageTitle>String</d2p1:MessageTitle>
      <d2p1:Receiver>String</d2p1:Receiver>
      <d2p1:SendMethodId>0</d2p1:SendMethodId>
      <d2p1:Sent>false</d2p1:Sent>
      <d2p1:SentDate>0001-01-01T00:00:00</d2p1:SentDate>
      <d2p1:StorageUrl>String</d2p1:StorageUrl>
      <d2p1:ToSendDate>0001-01-01T00:00:00</d2p1:ToSendDate>
    </d2p1:MessageLogQueryResponse>
  </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>
</QueryResponseOfMessageLogQueryResponseWg5EthtI>