ClubManager.Api

FindJournal

**Requires Authentication**
Required role:	API

The following routes are available for this service:
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(){}
}

Swift FindJournal 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.

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

<FindJournal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</FindJournal>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfJournalInstancePEZRWkv_P 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/ClubManager.Api.Services.Query">
    <d2p1:JournalInstance>
      <d2p1:AssignedToUserId>0</d2p1:AssignedToUserId>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:Completed>false</d2p1:Completed>
      <d2p1:CompletedDate>0001-01-01T00:00:00</d2p1:CompletedDate>
      <d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:Demo>false</d2p1:Demo>
      <d2p1:JournalDate>0001-01-01T00:00:00</d2p1:JournalDate>
      <d2p1:JournalId>0</d2p1:JournalId>
      <d2p1:Member>
        <d2p1:AchievementPoints>0</d2p1:AchievementPoints>
        <d2p1:Address1>String</d2p1:Address1>
        <d2p1:Address2>String</d2p1:Address2>
        <d2p1:AgreedToTerms>0001-01-01T00:00:00</d2p1:AgreedToTerms>
        <d2p1:AssignedToUserId>0</d2p1:AssignedToUserId>
        <d2p1:Balance>0</d2p1:Balance>
        <d2p1:CardNumber>String</d2p1:CardNumber>
        <d2p1:City>String</d2p1:City>
        <d2p1:CompanyName>String</d2p1:CompanyName>
        <d2p1:Country>String</d2p1:Country>
        <d2p1:County>String</d2p1:County>
        <d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
        <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
        <d2p1:CreditLimit>0</d2p1:CreditLimit>
        <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:DeletedByUserId>0</d2p1:DeletedByUserId>
        <d2p1:DeletedDate>0001-01-01T00:00:00</d2p1:DeletedDate>
        <d2p1:Demo>false</d2p1:Demo>
        <d2p1:DirectDebitAccountHolder>String</d2p1:DirectDebitAccountHolder>
        <d2p1:DirectDebitAccountNumber>String</d2p1:DirectDebitAccountNumber>
        <d2p1:DirectDebitBankAddress>String</d2p1:DirectDebitBankAddress>
        <d2p1:DirectDebitSortCode>String</d2p1:DirectDebitSortCode>
        <d2p1:EmailAddress>String</d2p1:EmailAddress>
        <d2p1:EmailOptOut>false</d2p1:EmailOptOut>
        <d2p1:EmergencyContact>String</d2p1:EmergencyContact>
        <d2p1:ExternalReference>String</d2p1:ExternalReference>
        <d2p1:ExternalSource>0</d2p1:ExternalSource>
        <d2p1:ExternalStatus>0</d2p1:ExternalStatus>
        <d2p1:FingerprintEnrolled>0001-01-01T00:00:00</d2p1:FingerprintEnrolled>
        <d2p1:FirstAidPermission>false</d2p1:FirstAidPermission>
        <d2p1:Forenames>String</d2p1:Forenames>
        <d2p1:FreeText>String</d2p1:FreeText>
        <d2p1:FullName>String</d2p1:FullName>
        <d2p1:Gender>0</d2p1:Gender>
        <d2p1:GiftAidPermission>false</d2p1:GiftAidPermission>
        <d2p1:HomePhone>String</d2p1:HomePhone>
        <d2p1:JoinedDate>0001-01-01T00:00:00</d2p1:JoinedDate>
        <d2p1:LastPaymentAmount>0</d2p1:LastPaymentAmount>
        <d2p1:LetterOptOut>false</d2p1:LetterOptOut>
        <d2p1:LossReason>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:Demo>false</d2p1:Demo>
          <d2p1:LossReasonId>0</d2p1:LossReasonId>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:Selectable>false</d2p1:Selectable>
        </d2p1:LossReason>
        <d2p1:LossReasonId>0</d2p1:LossReasonId>
        <d2p1:MemberId>0</d2p1:MemberId>
        <d2p1:MemberKey>00000000-0000-0000-0000-000000000000</d2p1:MemberKey>
        <d2p1:MemberType>0</d2p1:MemberType>
        <d2p1:MembershipNumber>String</d2p1:MembershipNumber>
        <d2p1:MobilePhone>String</d2p1:MobilePhone>
        <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:MonthlyAttendanceFrequency>0</d2p1:MonthlyAttendanceFrequency>
        <d2p1:Notes>String</d2p1:Notes>
        <d2p1:OnlineBookingBanned>false</d2p1:OnlineBookingBanned>
        <d2p1:ParentForenames>String</d2p1:ParentForenames>
        <d2p1:ParentSurname>String</d2p1:ParentSurname>
        <d2p1:PhoneOptOut>false</d2p1:PhoneOptOut>
        <d2p1:Photo>AA==</d2p1:Photo>
        <d2p1:PhotoModifiedDate>0001-01-01T00:00:00</d2p1:PhotoModifiedDate>
        <d2p1:PhotoPermission>false</d2p1:PhotoPermission>
        <d2p1:Pin>String</d2p1:Pin>
        <d2p1:Postcode>String</d2p1:Postcode>
        <d2p1:ProspectingPoints>0</d2p1:ProspectingPoints>
        <d2p1:RetentionMetric>0</d2p1:RetentionMetric>
        <d2p1:SmsOptOut>false</d2p1:SmsOptOut>
        <d2p1:Surname>String</d2p1:Surname>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:UseExternalStatus>false</d2p1:UseExternalStatus>
        <d2p1:WonOrLost>0</d2p1:WonOrLost>
        <d2p1:WonOrLostByUser>
          <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
          <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
          <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
          <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
          <d2p1:Enabled>false</d2p1:Enabled>
          <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
          <d2p1:MobilePhone>String</d2p1:MobilePhone>
          <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Notifications>false</d2p1:Notifications>
          <d2p1:Training>false</d2p1:Training>
          <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
          <d2p1:UserId>0</d2p1:UserId>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:WonOrLostByUser>
        <d2p1:WonOrLostByUserId>0</d2p1:WonOrLostByUserId>
        <d2p1:WonOrLostDate>0001-01-01T00:00:00</d2p1:WonOrLostDate>
      </d2p1:Member>
      <d2p1:MemberId>0</d2p1:MemberId>
      <d2p1:Message>
        <d2p1:BouncedDate>0001-01-01T00:00:00</d2p1:BouncedDate>
        <d2p1:DeliveredDate>0001-01-01T00:00:00</d2p1:DeliveredDate>
        <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
        <d2p1:Failures>0</d2p1:Failures>
        <d2p1:InstanceId>0</d2p1:InstanceId>
        <d2p1:InstanceType>0</d2p1:InstanceType>
        <d2p1:MessageId>0</d2p1:MessageId>
        <d2p1:MessageSid>String</d2p1:MessageSid>
        <d2p1:MessageTemplate>
          <d2p1:Body>String</d2p1:Body>
          <d2p1:ContentType>0</d2p1:ContentType>
          <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
          <d2p1:DeletedBy>0</d2p1:DeletedBy>
          <d2p1:EventType>0</d2p1:EventType>
          <d2p1:ExclusionTags>String</d2p1:ExclusionTags>
          <d2p1:Hidden>false</d2p1:Hidden>
          <d2p1:InclusionTags>String</d2p1:InclusionTags>
          <d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
          <d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
          <d2p1:ModifiedBy>0</d2p1:ModifiedBy>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:ParentMessageTemplateId>0</d2p1:ParentMessageTemplateId>
          <d2p1:ReportId>0</d2p1:ReportId>
          <d2p1:Subject>String</d2p1:Subject>
          <d2p1:TemplateType>0</d2p1:TemplateType>
        </d2p1:MessageTemplate>
        <d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
        <d2p1:OpenedDate>0001-01-01T00:00:00</d2p1:OpenedDate>
        <d2p1:Processed>false</d2p1:Processed>
        <d2p1:SentDate>0001-01-01T00:00:00</d2p1:SentDate>
        <d2p1:SpamReportDate>0001-01-01T00:00:00</d2p1:SpamReportDate>
        <d2p1:UnsubscribedDate>0001-01-01T00:00:00</d2p1:UnsubscribedDate>
        <d2p1:User>
          <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
          <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
          <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
          <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
          <d2p1:Enabled>false</d2p1:Enabled>
          <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
          <d2p1:MobilePhone>String</d2p1:MobilePhone>
          <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Notifications>false</d2p1:Notifications>
          <d2p1:Training>false</d2p1:Training>
          <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
          <d2p1:UserId>0</d2p1:UserId>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:User>
        <d2p1:UserId>0</d2p1:UserId>
      </d2p1:Message>
      <d2p1:MessageId>0</d2p1:MessageId>
      <d2p1:MessageType>0</d2p1:MessageType>
      <d2p1:NoShow>false</d2p1:NoShow>
      <d2p1:Permanent>false</d2p1:Permanent>
      <d2p1:PostponedCount>0</d2p1:PostponedCount>
      <d2p1:SendSMSReminder>false</d2p1:SendSMSReminder>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:ViewedDate>0001-01-01T00:00:00</d2p1:ViewedDate>
      <d2p1:alertDate>0001-01-01T00:00:00</d2p1:alertDate>
    </d2p1:JournalInstance>
  </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>
</QueryResponseOfJournalInstancePEZRWkv_P>