digitaluapi

Files

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
All Verbs	/restfiles/files
All Verbs	/restfiles/files/{Path*}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class Files
{
    open var Path:String? = null
    open var TextContents:String? = null
    open var ForDownload:Boolean? = null
}

open class FilesResponse
{
    open var Directory:FolderResult? = null
    open var File:FileResult? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FolderResult
{
    open var Folders:ArrayList<Folder>? = null
    open var Files:ArrayList<File>? = null
}

open class Folder
{
    open var Name:String? = null
    open var ModifiedDate:Date? = null
    open var FileCount:Int? = null
}

open class File
{
    open var Name:String? = null
    open var Extension:String? = null
    open var FileSizeBytes:Long? = null
    open var ModifiedDate:Date? = null
    open var IsTextFile:Boolean? = null
}

open class FileResult
{
    open var Name:String? = null
    open var Extension:String? = null
    open var FileSizeBytes:Long? = null
    open var ModifiedDate:Date? = null
    open var IsTextFile:Boolean? = null
    open var Contents:String? = null
}

Kotlin Files DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /restfiles/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Path: String,
	TextContents: String,
	ForDownload: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Directory: 
	{
		Folders: 
		[
			{
				Name: String,
				ModifiedDate: 0001-01-01,
				FileCount: 0
			}
		],
		Files: 
		[
			{
				Name: String,
				Extension: String,
				FileSizeBytes: 0,
				ModifiedDate: 0001-01-01,
				IsTextFile: False
			}
		]
	},
	File: 
	{
		Name: String,
		Extension: String,
		FileSizeBytes: 0,
		ModifiedDate: 0001-01-01,
		IsTextFile: False,
		Contents: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}