| Required role: | API |
| All Verbs | /api/Query/Journal |
|---|
import Foundation
import ServiceStack
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Journal")
public class FindJournal : QueryDb<JournalInstance>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class JournalInstance : Codable
{
public var journalId:Int?
public var journalDate:Date?
public var title:String?
public var comment:String?
public var messageType:Int?
public var userName:String?
public var member:MemberInstance?
// @References(typeof(MemberInstance))
public var memberId:Int?
public var message:MessageInstance?
// @References(typeof(MessageInstance))
public var messageId:Int?
public var viewedDate:Date?
public var deleted:Bool?
public var demo:Bool?
public var permanent:Bool?
public var alertDate:Date?
public var assignedToUserId:Int?
public var completed:Bool?
public var completedDate:Date?
public var createdByUserId:Int?
public var postponedCount:Int?
public var sendSMSReminder:Bool?
public var noShow:Bool?
required public init(){}
}
public class MemberInstance : Codable
{
public var memberId:Int?
public var memberType:Int?
public var membershipNumber:String?
public var cardNumber:String?
public var companyName:String?
public var surname:String?
public var forenames:String?
public var title:String?
public var gender:Int?
public var dateOfBirth:Date?
public var address1:String?
public var address2:String?
public var city:String?
public var county:String?
public var postcode:String?
public var homePhone:String?
public var mobilePhone:String?
public var emailAddress:String?
public var emailOptOut:Bool?
public var smsOptOut:Bool?
public var phoneOptOut:Bool?
public var letterOptOut:Bool?
public var directDebitAccountHolder:String?
public var directDebitAccountNumber:String?
public var directDebitSortCode:String?
public var joinedDate:Date?
public var directDebitBankAddress:String?
public var fullName:String?
public var externalReference:String?
public var photo:[UInt8] = []
public var photoModifiedDate:Date?
public var notes:String?
public var deleted:Bool?
public var demo:Bool?
public var useExternalStatus:Bool?
public var externalStatus:Int?
public var freeText:String?
public var memberKey:String?
public var balance:Double?
public var creditLimit:Double?
public var createdDate:Date?
public var modifiedDate:Date?
public var deletedDate:Date?
public var externalSource:Int?
public var retentionMetric:Double?
public var monthlyAttendanceFrequency:Double?
public var assignedToUserId:Int?
public var createdByUserId:Int?
public var deletedByUserId:Int?
public var lossReason:LossReasonInstance?
// @References(typeof(LossReasonInstance))
public var lossReasonId:Int?
public var wonOrLost:Int?
public var wonOrLostDate:Date?
public var giftAidPermission:Bool?
public var photoPermission:Bool?
public var firstAidPermission:Bool?
public var emergencyContact:String?
public var wonOrLostByUser:UserInstance?
// @References(typeof(UserInstance))
public var wonOrLostByUserId:Int?
public var agreedToTerms:Date?
public var onlineBookingBanned:Bool?
public var country:String?
public var fingerprintEnrolled:Date?
public var lastPaymentAmount:Double?
public var pin:String?
public var prospectingPoints:Int?
public var achievementPoints:Int?
public var parentForenames:String?
public var parentSurname:String?
required public init(){}
}
public class LossReasonInstance : Codable
{
public var lossReasonId:Int?
public var reason:String?
public var deleted:Bool?
public var demo:Bool?
public var selectable:Bool?
required public init(){}
}
public class UserInstance : Codable
{
public var userId:Int?
public var userName:String?
public var name:String?
public var email:String?
public var mobilePhone:String?
public var enabled:Bool?
public var lastLogin:Date?
public var created:Date?
public var training:Bool?
public var deleted:Bool?
public var coursesCompleted:Int?
public var displayHomeNotification:Bool?
public var twoFactorEnabled:Bool?
public var emailConfirmed:Bool?
public var mobilePhoneConfirmed:Bool?
public var notifications:Bool?
public var changePassword:Date?
public var activated:Date?
required public init(){}
}
public class MessageInstance : Codable
{
public var messageId:Int?
public var dueDate:Date?
public var sentDate:Date?
public var processed:Bool?
public var failures:Int?
public var instanceId:Int?
public var messageSid:String?
public var messageTemplate:MessageTemplateInstance?
// @References(typeof(MessageTemplateInstance))
public var messageTemplateId:Int?
public var openedDate:Date?
public var bouncedDate:Date?
public var deliveredDate:Date?
public var unsubscribedDate:Date?
public var spamReportDate:Date?
public var user:UserInstance?
// @References(typeof(UserInstance))
public var userId:Int?
public var instanceType:Int?
required public init(){}
}
public class MessageTemplateInstance : Codable
{
public var messageTemplateId:Int?
public var name:String?
public var subject:String?
public var body:String?
public var reportId:Int?
public var templateType:Int?
public var created:Date?
public var createdBy:Int?
public var modified:Date?
public var modifiedBy:Int?
public var deleted:Date?
public var deletedBy:Int?
public var eventType:Int?
public var contentType:Int?
public var hidden:Bool?
public var parentMessageTemplateId:Int?
public var inclusionTags:String?
public var exclusionTags:String?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}