ClubManager.Api

<back to all web services

FindMessage

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class MessageTemplateInstance
{
    public MessageTemplateId?: number;
    public Name?: string;
    public Subject?: string;
    public Body?: string;
    public ReportId?: number;
    public TemplateType?: number;
    public Created?: string;
    public CreatedBy?: number;
    public Modified?: string;
    public ModifiedBy?: number;
    public Deleted?: string;
    public DeletedBy?: number;
    public EventType?: number;
    public ContentType?: number;
    public Hidden?: boolean;
    public ParentMessageTemplateId?: number;
    public InclusionTags?: string;
    public ExclusionTags?: string;

    public constructor(init?: Partial<MessageTemplateInstance>) { (Object as any).assign(this, init); }
}

export class UserInstance
{
    public UserId?: number;
    public UserName?: string;
    public Name?: string;
    public Email?: string;
    public MobilePhone?: string;
    public Enabled?: boolean;
    public LastLogin?: string;
    public Created?: string;
    public Training?: boolean;
    public Deleted?: boolean;
    public CoursesCompleted?: number;
    public DisplayHomeNotification?: boolean;
    public TwoFactorEnabled?: boolean;
    public EmailConfirmed?: boolean;
    public MobilePhoneConfirmed?: boolean;
    public Notifications?: boolean;
    public ChangePassword?: string;
    public Activated?: string;

    public constructor(init?: Partial<UserInstance>) { (Object as any).assign(this, init); }
}

export class MessageInstance
{
    public MessageId?: number;
    public DueDate?: string;
    public SentDate?: string;
    public Processed?: boolean;
    public Failures?: number;
    public InstanceId?: number;
    public MessageSid?: string;
    public MessageTemplate?: MessageTemplateInstance;
    // @References("typeof(ClubManager.Api.Services.Query.MessageTemplateInstance)")
    public MessageTemplateId?: number;

    public OpenedDate?: string;
    public BouncedDate?: string;
    public DeliveredDate?: string;
    public UnsubscribedDate?: string;
    public SpamReportDate?: string;
    public User?: UserInstance;
    // @References("typeof(ClubManager.Api.Services.Query.UserInstance)")
    public UserId?: number;

    public InstanceType?: number;

    public constructor(init?: Partial<MessageInstance>) { (Object as any).assign(this, init); }
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Message")
export class FindMessage extends QueryDb<MessageInstance>
{

    public constructor(init?: Partial<FindMessage>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset?: number;

    // @DataMember(Order=2)
    public Total?: number;

    // @DataMember(Order=3)
    public Results?: T[];

    // @DataMember(Order=4)
    public Meta?: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript FindMessage DTOs

POST /api/Query/Message 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: 
	[
		{
			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
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}