ClubManager.Api

FindFileAttachment

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/FileAttachment

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Api.Services.Query

Namespace Global

    Namespace ClubManager.Api.Services.Query

        Public Partial Class FileAttachmentInstance
            Public Sub New()
                FileData = New Byte(){}
                Thumbnail = New Byte(){}
            End Sub

            Public Overridable Property FileAttachmentId As Integer
            Public Overridable Property FileData As Byte()
            Public Overridable Property MimeType As String
            Public Overridable Property InstanceId As Integer
            Public Overridable Property InstanceType As String
            Public Overridable Property UploadedByUserId As Integer
            Public Overridable Property UploadedDate As Date
            Public Overridable Property FileSize As Decimal
            Public Overridable Property Filename As String
            Public Overridable Property Thumbnail As Byte()
            Public Overridable Property PublicKey As Guid
        End Class

        <AutoQueryViewer(Description:="", IconUrl:="octicon:database", Title:="FileAttachment")>
        Public Partial Class FindFileAttachment
            Inherits QueryDb(Of FileAttachmentInstance)
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET FindFileAttachment 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/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>