| Required role: | API |
| All Verbs | /api/Query/FileAttachment |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileAttachmentId | form | int | No | |
| FileData | form | byte[] | No | |
| MimeType | form | string | No | |
| InstanceId | form | int | No | |
| InstanceType | form | string | No | |
| UploadedByUserId | form | int | No | |
| UploadedDate | form | DateTime | No | |
| FileSize | form | decimal | No | |
| Filename | form | string | No | |
| Thumbnail | form | byte[] | No | |
| PublicKey | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
FileAttachmentId: 0,
FileData: AA==,
MimeType: String,
InstanceId: 0,
InstanceType: String,
UploadedByUserId: 0,
UploadedDate: 0001-01-01,
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
}
}
}