FileService Datatypes
Back to FileService
FileInfo
| Property | Type | Description |
|---|
| FileId | Int32 | DefaultValue: -2,147,483,648 |
| FileType | FileType | DefaultValue: O24S |
| FolderId | Int32 | DefaultValue: -2,147,483,648 |
| Name | String | DefaultValue: “” |
| Extension | String | DefaultValue: “” |
| Size | Int32 | DefaultValue: -2,147,483,648 |
| DateReg | DateTime | DefaultValue: “1.1.0001” |
| DateChanged | DateTime | DefaultValue: “1.1.0001” |
| DeletedType | DeletedType | DefaultValue: NotDeleted |
| IsCheckedOut | Boolean | DefaultValue: false |
| CheckOutDate | DateTime | DefaultValue: “1.1.0001” |
| CheckOutName | String | DefaultValue: “” |
| CheckSum | String | This displays a custom MD5 checksum of the date in which the file was last changed. |
GetFileInfo
| Property | Type | Description |
|---|
| Length | Int | |
| TmpId | String | |
Folder
| Property | Type | Description |
|---|
| Id | Int32 | DefaultValue: -2,147,483,648 |
| Name | String | DefaultValue: “” |
| ParentId | Int32 | DefaultValue: -2,147,483,648 |
| Type | FolderType | DefaultValue: Default |
| DateChanged | DateTime | DefaultValue: “1.1.0001” |
| DeletedType | DeletedType | DefaultValue: NotDeleted |
| Files | File[] | |
| Folders | Folder[] | |
Parameters
| Property | Type | Description |
|---|
| FolderId | Int32 | DefaultValue: -2,147,483,648 |
| Search | TriStateTriState | DefaultValue: none – Not in use |
| FileName | String | DefaultValue: “” – Not in use |
| FileExtention | String | DefaultValue: “” – Not in use |
| SearchFolderId | Int32 | DefaultValue: -2,147,483,648 – Not in use |
| DateType | SearchTypeDate | DefaultValue: none – Not in use |
| DateFrom | DateTime | DefaultValue: “1.1.0001” – Not in use |
| DateTo | DateTime | DefaultValue: “1.1.0001” – Not in use |
| SizeType | SearchTypeSize | DefaultValue: none – Not in use |
| Size | Int32 | DefaultValue: -2,147,483,648 – Not in use |
| TypeOfResult | ResultType | DefaultValue: All |
| ProjectId | Int32 | If set, the method will return the root folder for the specified project |
| CustomerId | Int32 | If set, the method will return the root folder for the specified customer |
| ContactId | Int32 | If set, the method will return the root folder for the specified contact |
| MyDocuments | Boolean | If set, the method will return the private My Documents folder |
GetFolderContentInfoResult
| Property | Type | Description |
|---|
| Id | Int32 | |
| Name | String | |
| ParentId | Int32 | |
| Type | Enum | Default
Picture
Audio |
| DateChanged | DateTime | |
| DeletedType | Enum | NotDeleted
Deleted
DeletedSubItem |
| Files | File[] | |
| Folders | Folder[] | |
FileInfoSearch
| Property | Type | Description |
|---|
| FolderId | Int32 | DefaultValue: -2,147,483,648 |
| Search | TriStateTriState | DefaultValue: none – Not in use |
| FileName | String | DefaultValue: “” – Not in use |
| FileExtention | String | DefaultValue: “” – Not in use |
| SearchFolderId | Int32 | DefaultValue: -2,147,483,648 – Not in use |
| DateType | SearchTypeDate | DefaultValue: none – Not in use |
| DateFrom | DateTime | DefaultValue: “1.1.0001” – Not in use |
| DateTo | DateTime | DefaultValue: “1.1.0001” – Not in use |
| SizeType | SearchTypeSize | DefaultValue: none – Not in use |
| Size | Int32 | DefaultValue: -2,147,483,648 – Not in use |
| TypeOfResult | ResultType | DefaultValue: All |
| ProjectId | Int32 | If set, the method will return the root folder for the specified project |
| CustomerId | Int32 | If set, the method will return the root folder for the specified customer |
| ContactId | Int32 | If set, the method will return the root folder for the specified contact |
| MyDocuments | Boolean | If set, the method will return the private My Documents folder |
TriState
| Name | Value | Description |
|---|
| none | 0 | |
| True | 1 | |
| False | 2 | |
SearchTypeSize
| Name | Value | Description |
|---|
| none | | |
| GreaterThan | | |
| LessThan | | |
SearchTypeDate
| Name | Value | Description |
|---|
| none | | |
| DateReg | | |
| DateChanged | | |
ResultType
| Name | Value | Description |
|---|
| All | | |
| Files | | |
| Folders | | |
DeletedType
| Name | Value | Description |
|---|
| NotDeleted | 0 | |
| Deleted | 1 | |
| DeletedSubItem | 2 | |
FolderType
| Name | Value | Description |
|---|
| Default | 1 | |
| Picture | 2 | |
| Audio | 3 | |
AppendChunk
| Property | Type | Description |
|---|
| TmpId | String | |
| Buffer | base64Binary | |
| Offset | Long | |
AppendChunkByLength
| Property | Type | Description |
|---|
| TmpId | String | |
| Buffer | base64Binary | |
| Offset | Long | |
| BufferLength | Int | |
Save
| Property | Type | Description |
|---|
| TmpId | String | |
| FileInfo | FileInfo | |
PrepareFileDownload
| Property | Type | Description |
|---|
| FileId | Int | |
| FolderId | Int | |
| CheckOut | Boolean | |
DownloadFileChunk
| Property | Type | Description |
|---|
| TmpId | String | |
| ChunckNum | Int | |
HashFile
| Property | Type | Description |
|---|
| TmpId | String | |
EndFileDownload
| Property | Type | Description |
|---|
| TmpId | String | |
FolderAndFile
This object is the same for ReleaseFile, Delete, GetFileInfo and FileSize.
| Property | Type | Description |
|---|
| FolderId | Int32 | |
| FileId | Int32 | |
Back to FileService
