ClubManager.Api

<back to all web services

FileAttachmentService.GetFileRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/FileAttachment/GetFile
namespace ClubManager.Interfaces.Models.FileAttachment

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FileAttachmentData() = 
        member val FileAttachmentId:Int32 = new Int32() with get,set
        member val BranchId:Int32 = new Int32() with get,set
        member val UploadedByUserId:Int32 = new Int32() with get,set
        member val FileData:Byte[] = [||] with get,set
        member val InstanceType:String = null with get,set
        member val InstanceId:Int32 = new Int32() with get,set
        member val Filename:String = null with get,set
        member val FileSize:Int32 = new Int32() with get,set
        member val MimeType:String = null with get,set
        member val Thumbnail:Byte[] = [||] with get,set

F# FileAttachmentService.GetFileRequest 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/FileAttachment/GetFile HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FileAttachmentService.GetFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <FileAttachmentId>0</FileAttachmentId>
</FileAttachmentService.GetFileRequest>

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

<FileAttachmentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.FileAttachment">
  <BranchId>0</BranchId>
  <FileAttachmentId>0</FileAttachmentId>
  <FileData>AA==</FileData>
  <FileSize>0</FileSize>
  <Filename>String</Filename>
  <InstanceId>0</InstanceId>
  <InstanceType>String</InstanceType>
  <MimeType>String</MimeType>
  <Thumbnail>AA==</Thumbnail>
  <UploadedByUserId>0</UploadedByUserId>
</FileAttachmentData>