ClubManager.Api

<back to all web services

FileAttachmentService.GetFileRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/FileAttachment/GetFile
FileAttachmentData Parameters:
NameParameterData TypeRequiredDescription
FileAttachmentIdformintNo
BranchIdformintNo
UploadedByUserIdformintNo
FileDataformbyte[]No
InstanceTypeformstringNo
InstanceIdformintNo
FilenameformstringNo
FileSizeformintNo
MimeTypeformstringNo
Thumbnailformbyte[]No

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>