Required role: | API |
All Verbs | /api/Query/FileAttachment |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubManager.Api.Services.Query;
namespace ClubManager.Api.Services.Query
{
public partial class FileAttachmentInstance
{
public FileAttachmentInstance()
{
FileData = new byte[]{};
Thumbnail = new byte[]{};
}
public virtual int FileAttachmentId { get; set; }
public virtual byte[] FileData { get; set; }
public virtual string MimeType { get; set; }
public virtual int InstanceId { get; set; }
public virtual string InstanceType { get; set; }
public virtual int UploadedByUserId { get; set; }
public virtual DateTime UploadedDate { get; set; }
public virtual decimal FileSize { get; set; }
public virtual string Filename { get; set; }
public virtual byte[] Thumbnail { get; set; }
public virtual Guid PublicKey { get; set; }
}
[AutoQueryViewer(Description="", IconUrl="octicon:database", Title="FileAttachment")]
public partial class FindFileAttachment
: QueryDb<FileAttachmentInstance>
{
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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/FileAttachment 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: [ { FileAttachmentId: 0, FileData: AA==, MimeType: String, InstanceId: 0, InstanceType: String, UploadedByUserId: 0, UploadedDate: 0001-01-01, FileSize: 0, Filename: String, Thumbnail: AA==, PublicKey: 00000000000000000000000000000000 } ], Meta: { String: String }, ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }