| Required role: | API |
| All Verbs | /api/Query/FileAttachment |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="FileAttachment")
public static class FindFileAttachment extends QueryDb<FileAttachmentInstance>
{
}
public static class QueryDb<T> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
@DataMember(Order=1)
public Integer Skip = null;
@DataMember(Order=2)
public Integer Take = null;
@DataMember(Order=3)
public String OrderBy = null;
@DataMember(Order=4)
public String OrderByDesc = null;
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class FileAttachmentInstance
{
public Integer FileAttachmentId = null;
public byte[] FileData = null;
public String MimeType = null;
public Integer InstanceId = null;
public String InstanceType = null;
public Integer UploadedByUserId = null;
public Date UploadedDate = null;
public BigDecimal FileSize = null;
public String Filename = null;
public byte[] Thumbnail = null;
public UUID PublicKey = null;
public Integer getFileAttachmentId() { return FileAttachmentId; }
public FileAttachmentInstance setFileAttachmentId(Integer value) { this.FileAttachmentId = value; return this; }
public byte[] getFileData() { return FileData; }
public FileAttachmentInstance setFileData(byte[] value) { this.FileData = value; return this; }
public String getMimeType() { return MimeType; }
public FileAttachmentInstance setMimeType(String value) { this.MimeType = value; return this; }
public Integer getInstanceId() { return InstanceId; }
public FileAttachmentInstance setInstanceId(Integer value) { this.InstanceId = value; return this; }
public String getInstanceType() { return InstanceType; }
public FileAttachmentInstance setInstanceType(String value) { this.InstanceType = value; return this; }
public Integer getUploadedByUserId() { return UploadedByUserId; }
public FileAttachmentInstance setUploadedByUserId(Integer value) { this.UploadedByUserId = value; return this; }
public Date getUploadedDate() { return UploadedDate; }
public FileAttachmentInstance setUploadedDate(Date value) { this.UploadedDate = value; return this; }
public BigDecimal getFileSize() { return FileSize; }
public FileAttachmentInstance setFileSize(BigDecimal value) { this.FileSize = value; return this; }
public String getFilename() { return Filename; }
public FileAttachmentInstance setFilename(String value) { this.Filename = value; return this; }
public byte[] getThumbnail() { return Thumbnail; }
public FileAttachmentInstance setThumbnail(byte[] value) { this.Thumbnail = value; return this; }
public UUID getPublicKey() { return PublicKey; }
public FileAttachmentInstance setPublicKey(UUID value) { this.PublicKey = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<T> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<T> getResults() { return Results; }
public QueryResponse<T> setResults(ArrayList<T> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FindFileAttachment 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>
</FindFileAttachment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfFileAttachmentInstancePEZRWkv_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:FileAttachmentInstance>
<d2p1:FileAttachmentId>0</d2p1:FileAttachmentId>
<d2p1:FileData>AA==</d2p1:FileData>
<d2p1:FileSize>0</d2p1:FileSize>
<d2p1:Filename>String</d2p1:Filename>
<d2p1:InstanceId>0</d2p1:InstanceId>
<d2p1:InstanceType>String</d2p1:InstanceType>
<d2p1:MimeType>String</d2p1:MimeType>
<d2p1:PublicKey>00000000-0000-0000-0000-000000000000</d2p1:PublicKey>
<d2p1:Thumbnail>AA==</d2p1:Thumbnail>
<d2p1:UploadedByUserId>0</d2p1:UploadedByUserId>
<d2p1:UploadedDate>0001-01-01T00:00:00</d2p1:UploadedDate>
</d2p1:FileAttachmentInstance>
</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>
</QueryResponseOfFileAttachmentInstancePEZRWkv_P>