BokaMera.API.Host

<back to all web services

NewsletterLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/newsletter/logSearch the newsletter log for any messagesSearch the newsletter log for any messages.
namespace BokaMera.API.ServiceModel.Db

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NewsletterLogQueryResponse() = 
        ///<summary>
        ///The message log id
        ///</summary>
        [<ApiMember(Description="The message log id")>]
        member val Id:Int32 = new Int32() with 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.")>]
        member val Receiver:String = null with get,set

        ///<summary>
        ///Nessage Title.
        ///</summary>
        [<ApiMember(Description="Nessage Title.")>]
        member val MessageTitle:String = null with get,set

        ///<summary>
        ///Nessage Body.
        ///</summary>
        [<ApiMember(Description="Nessage Body.")>]
        member val MessageBody:String = null with get,set

        ///<summary>
        ///When message was created.
        ///</summary>
        [<ApiMember(Description="When message was created.")>]
        member val Created:DateTime = new DateTime() with get,set

        ///<summary>
        ///When the message will be sent.
        ///</summary>
        [<ApiMember(Description="When the message will be sent.")>]
        member val ToSendDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///When the message was sent.
        ///</summary>
        [<ApiMember(Description="When the message was sent.")>]
        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///If Message is sent
        ///</summary>
        [<ApiMember(Description="If Message is sent")>]
        member val Sent:Boolean = new Boolean() with get,set

        ///<summary>
        ///Number of retries to send the message
        ///</summary>
        [<ApiMember(Description="Number of retries to send the message")>]
        member val MessageRetries:Int32 = new Int32() with get,set

        ///<summary>
        ///Send Method. 1 = Email, 2 = SMS
        ///</summary>
        [<ApiMember(Description="Send Method. 1 = Email, 2 = SMS")>]
        member val SendMethodId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BaseModel() = 
        class end

    [<AllowNullLiteral>]
    type NewsletterLog() = 
        inherit BaseModel()
        member val NewslettersId:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<Required>]
        member val SenderName:String = null with get,set

        member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val CorrelationId:Nullable<Guid> = new Nullable<Guid>() with get,set
        [<Required>]
        member val CompanyId:Guid = new Guid() with get,set

        member val Id:Int32 = new Int32() with get,set
        [<Required>]
        member val SendMethodId:Int32 = new Int32() with get,set

        [<Required>]
        member val Receiver:String = null with get,set

        [<Required>]
        member val Sender:String = null with get,set

        member val MessageTitle:String = null with get,set
        [<Required>]
        member val MessageBody:String = null with get,set

        [<Required>]
        member val Sent:Boolean = new Boolean() with get,set

        [<Required>]
        member val ToSendDate:DateTime = new DateTime() with get,set

        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MessageCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SMSStatus:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<Required>]
        member val MessageRetries:Int32 = new Int32() with get,set

        member val CreatedBy:String = null with get,set
        [<Required>]
        member val Created:DateTime = new DateTime() with get,set

        member val StorageUrl:String = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type NewsletterLogQuery() = 
        inherit QueryDb<NewsletterLog, NewsletterLogQueryResponse>()
        ///<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with 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")>]
        member val Sent:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Message Id
        ///</summary>
        [<ApiMember(DataType="int", Description="Message Id", ParameterType="query")>]
        member val Id:Nullable<Int32> = new Nullable<Int32>() with 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")>]
        member val Receiver:String = null with 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")>]
        member val Created:Nullable<DateTime> = new Nullable<DateTime>() with 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")>]
        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        ///<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)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with 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)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with 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)>]
        member val OrderBy:String = null with 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)>]
        member val OrderByDesc:String = null with 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)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<From, Into>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type AccessKeyTypeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val KeyType:String = null with get,set
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<AccessKeyTypeResponse>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# NewsletterLogQuery DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}