ClubManager.Api

<back to all web services

FindFileAttachment

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/FileAttachment
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
FileAttachmentInstance Parameters:
NameParameterData TypeRequiredDescription
FileAttachmentIdformintNo
FileDataformbyte[]No
MimeTypeformstringNo
InstanceIdformintNo
InstanceTypeformstringNo
UploadedByUserIdformintNo
UploadedDateformDateTimeNo
FileSizeformdecimalNo
FilenameformstringNo
Thumbnailformbyte[]No
PublicKeyformGuidNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"FileAttachmentId":0,"FileData":"AA==","MimeType":"String","InstanceId":0,"InstanceType":"String","UploadedByUserId":0,"UploadedDate":"0001-01-01T00:00:00.0000000","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"}}}