ClubManager.Api

FindJournal

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Journal

namespace ClubManager.Api.Services.Query

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

    [<AllowNullLiteral>]
    type LossReasonInstance() = 
        member val LossReasonId:Int32 = new Int32() with get,set
        member val Reason:String = null with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val Selectable:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UserInstance() = 
        member val UserId:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val CoursesCompleted:Int32 = new Int32() with get,set
        member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MemberInstance() = 
        member val MemberId:Int32 = new Int32() with get,set
        member val MemberType:Int32 = new Int32() with get,set
        member val MembershipNumber:String = null with get,set
        member val CardNumber:String = null with get,set
        member val CompanyName:String = null with get,set
        member val Surname:String = null with get,set
        member val Forenames:String = null with get,set
        member val Title:String = null with get,set
        member val Gender:Int32 = new Int32() with get,set
        member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val County:String = null with get,set
        member val Postcode:String = null with get,set
        member val HomePhone:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val EmailOptOut:Boolean = new Boolean() with get,set
        member val SmsOptOut:Boolean = new Boolean() with get,set
        member val PhoneOptOut:Boolean = new Boolean() with get,set
        member val LetterOptOut:Boolean = new Boolean() with get,set
        member val DirectDebitAccountHolder:String = null with get,set
        member val DirectDebitAccountNumber:String = null with get,set
        member val DirectDebitSortCode:String = null with get,set
        member val JoinedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DirectDebitBankAddress:String = null with get,set
        member val FullName:String = null with get,set
        member val ExternalReference:String = null with get,set
        member val Photo:Byte[] = [||] with get,set
        member val PhotoModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Notes:String = null with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val UseExternalStatus:Boolean = new Boolean() with get,set
        member val ExternalStatus:Int32 = new Int32() with get,set
        member val FreeText:String = null with get,set
        member val MemberKey:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Balance:Decimal = new Decimal() with get,set
        member val CreditLimit:Decimal = new Decimal() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExternalSource:Int32 = new Int32() with get,set
        member val RetentionMetric:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MonthlyAttendanceFrequency:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AssignedToUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeletedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LossReason:LossReasonInstance = null with get,set
        [<References(typeof<LossReasonInstance>)>]
        member val LossReasonId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val WonOrLost:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WonOrLostDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val GiftAidPermission:Boolean = new Boolean() with get,set
        member val PhotoPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val FirstAidPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val EmergencyContact:String = null with get,set
        member val WonOrLostByUser:UserInstance = null with get,set
        [<References(typeof<UserInstance>)>]
        member val WonOrLostByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val AgreedToTerms:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OnlineBookingBanned:Boolean = new Boolean() with get,set
        member val Country:String = null with get,set
        member val FingerprintEnrolled:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastPaymentAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Pin:String = null with get,set
        member val ProspectingPoints:Int32 = new Int32() with get,set
        member val AchievementPoints:Int32 = new Int32() with get,set
        member val ParentForenames:String = null with get,set
        member val ParentSurname:String = null with get,set

    [<AllowNullLiteral>]
    type MessageTemplateInstance() = 
        member val MessageTemplateId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Subject:String = null with get,set
        member val Body:String = null with get,set
        member val ReportId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TemplateType:Int32 = new Int32() with get,set
        member val Created:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Modified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModifiedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EventType:Int32 = new Int32() with get,set
        member val ContentType:Int32 = new Int32() with get,set
        member val Hidden:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ParentMessageTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InclusionTags:String = null with get,set
        member val ExclusionTags:String = null with get,set

    [<AllowNullLiteral>]
    type MessageInstance() = 
        member val MessageId:Int32 = new Int32() with get,set
        member val DueDate:DateTime = new DateTime() with get,set
        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Processed:Boolean = new Boolean() with get,set
        member val Failures:Int32 = new Int32() with get,set
        member val InstanceId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MessageSid:String = null with get,set
        member val MessageTemplate:MessageTemplateInstance = null with get,set
        [<References(typeof<MessageTemplateInstance>)>]
        member val MessageTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val OpenedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val BouncedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeliveredDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UnsubscribedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SpamReportDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val User:UserInstance = null with get,set
        [<References(typeof<UserInstance>)>]
        member val UserId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val InstanceType:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type JournalInstance() = 
        member val JournalId:Int32 = new Int32() with get,set
        member val JournalDate:DateTime = new DateTime() with get,set
        member val Title:String = null with get,set
        member val Comment:String = null with get,set
        member val MessageType:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Member:MemberInstance = null with get,set
        [<References(typeof<MemberInstance>)>]
        member val MemberId:Int32 = new Int32() with get,set

        member val Message:MessageInstance = null with get,set
        [<References(typeof<MessageInstance>)>]
        member val MessageId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val ViewedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val Permanent:Boolean = new Boolean() with get,set
        member val alertDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AssignedToUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Completed:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CompletedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PostponedCount:Int32 = new Int32() with get,set
        member val SendSMSReminder:Boolean = new Boolean() with get,set
        member val NoShow:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Journal")>]
    [<AllowNullLiteral>]
    type FindJournal() = 
        inherit QueryDb<JournalInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

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

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

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

        [<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<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<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<'T> = new ResizeArray<'T>() 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# FindJournal 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.

POST /api/Query/Journal HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			JournalId: 0,
			JournalDate: 0001-01-01,
			Title: String,
			Comment: String,
			MessageType: 0,
			UserName: String,
			Member: 
			{
				MemberId: 0,
				MemberType: 0,
				MembershipNumber: String,
				CardNumber: String,
				CompanyName: String,
				Surname: String,
				Forenames: String,
				Title: String,
				Gender: 0,
				DateOfBirth: 0001-01-01,
				Address1: String,
				Address2: String,
				City: String,
				County: String,
				Postcode: String,
				HomePhone: String,
				MobilePhone: String,
				EmailAddress: String,
				EmailOptOut: False,
				SmsOptOut: False,
				PhoneOptOut: False,
				LetterOptOut: False,
				DirectDebitAccountHolder: String,
				DirectDebitAccountNumber: String,
				DirectDebitSortCode: String,
				JoinedDate: 0001-01-01,
				DirectDebitBankAddress: String,
				FullName: String,
				ExternalReference: String,
				Photo: AA==,
				PhotoModifiedDate: 0001-01-01,
				Notes: String,
				Deleted: False,
				Demo: False,
				UseExternalStatus: False,
				ExternalStatus: 0,
				FreeText: String,
				MemberKey: 00000000000000000000000000000000,
				Balance: 0,
				CreditLimit: 0,
				CreatedDate: 0001-01-01,
				ModifiedDate: 0001-01-01,
				DeletedDate: 0001-01-01,
				ExternalSource: 0,
				RetentionMetric: 0,
				MonthlyAttendanceFrequency: 0,
				AssignedToUserId: 0,
				CreatedByUserId: 0,
				DeletedByUserId: 0,
				LossReason: 
				{
					LossReasonId: 0,
					Reason: String,
					Deleted: False,
					Demo: False,
					Selectable: False
				},
				LossReasonId: 0,
				WonOrLost: 0,
				WonOrLostDate: 0001-01-01,
				GiftAidPermission: False,
				PhotoPermission: False,
				FirstAidPermission: False,
				EmergencyContact: String,
				WonOrLostByUser: 
				{
					UserId: 0,
					UserName: String,
					Name: String,
					Email: String,
					MobilePhone: String,
					Enabled: False,
					LastLogin: 0001-01-01,
					Created: 0001-01-01,
					Training: False,
					Deleted: False,
					CoursesCompleted: 0,
					DisplayHomeNotification: False,
					TwoFactorEnabled: False,
					EmailConfirmed: False,
					MobilePhoneConfirmed: False,
					Notifications: False,
					ChangePassword: 0001-01-01,
					Activated: 0001-01-01
				},
				WonOrLostByUserId: 0,
				AgreedToTerms: 0001-01-01,
				OnlineBookingBanned: False,
				Country: String,
				FingerprintEnrolled: 0001-01-01,
				LastPaymentAmount: 0,
				Pin: String,
				ProspectingPoints: 0,
				AchievementPoints: 0,
				ParentForenames: String,
				ParentSurname: String
			},
			MemberId: 0,
			Message: 
			{
				MessageId: 0,
				DueDate: 0001-01-01,
				SentDate: 0001-01-01,
				Processed: False,
				Failures: 0,
				InstanceId: 0,
				MessageSid: String,
				MessageTemplate: 
				{
					MessageTemplateId: 0,
					Name: String,
					Subject: String,
					Body: String,
					ReportId: 0,
					TemplateType: 0,
					Created: 0001-01-01,
					CreatedBy: 0,
					Modified: 0001-01-01,
					ModifiedBy: 0,
					Deleted: 0001-01-01,
					DeletedBy: 0,
					EventType: 0,
					ContentType: 0,
					Hidden: False,
					ParentMessageTemplateId: 0,
					InclusionTags: String,
					ExclusionTags: String
				},
				MessageTemplateId: 0,
				OpenedDate: 0001-01-01,
				BouncedDate: 0001-01-01,
				DeliveredDate: 0001-01-01,
				UnsubscribedDate: 0001-01-01,
				SpamReportDate: 0001-01-01,
				User: 
				{
					UserId: 0,
					UserName: String,
					Name: String,
					Email: String,
					MobilePhone: String,
					Enabled: False,
					LastLogin: 0001-01-01,
					Created: 0001-01-01,
					Training: False,
					Deleted: False,
					CoursesCompleted: 0,
					DisplayHomeNotification: False,
					TwoFactorEnabled: False,
					EmailConfirmed: False,
					MobilePhoneConfirmed: False,
					Notifications: False,
					ChangePassword: 0001-01-01,
					Activated: 0001-01-01
				},
				UserId: 0,
				InstanceType: 0
			},
			MessageId: 0,
			ViewedDate: 0001-01-01,
			Deleted: False,
			Demo: False,
			Permanent: False,
			alertDate: 0001-01-01,
			AssignedToUserId: 0,
			Completed: False,
			CompletedDate: 0001-01-01,
			CreatedByUserId: 0,
			PostponedCount: 0,
			SendSMSReminder: False,
			NoShow: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}